# Propeller Commerce Documentation — Full Content

> Complete text of all hand-written Propeller Commerce documentation. Auto-generated API reference pages (GraphQL schema, REST endpoints) are excluded — use the APIs directly for schema introspection.

## Authentication and Authorization

URL: https://docs.propeller-commerce.com/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization

# Authentication and authorization

Register companies and contacts (B2B), register customers (B2C), log in, manage access tokens and implement session handling using Propeller's GraphQL API.

## API key setup

Every request to the GraphQL API requires an `apiKey` header. Propeller provides two key types:

- **System API key** has full access and is for server-side use only. Never expose this in frontend code.
- **Limited API key** provides anonymous access for frontend use. Supports browsing products, creating carts and registering users.

```bash
curl https://api.propellercommerce.com/graphql \
  -X POST \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_LIMITED_API_KEY" \
  -d '{"query": "{ viewer { __typename } }"}'
```

Once a user logs in, add the access token alongside the API key:

```bash
curl https://api.propellercommerce.com/graphql \
  -X POST \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_LIMITED_API_KEY" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -d '{"query": "{ viewer { firstName lastName email } }"}'
```

## Registering a company and contact (B2B)

B2B registration is a two-step process: first create the company, then register a contact within it.

### Step 1: Create the company

```graphql
mutation {
  companyCreate(
    input: {
      name: "Acme Corp"
      taxNumber: "NL123456789B01"
    }
  ) {
    companyId
    name
  }
}
```

**Expected response:**

```json
{
  "data": {
    "companyCreate": {
      "companyId": 456,
      "name": "Acme Corp"
    }
  }
}
```

### Step 2: Register a contact

Use the `companyId` from step 1 as the `parentId`:

```graphql
mutation {
  contactRegister(
    input: {
      firstName: "Jane"
      lastName: "Smith"
      email: "jane@acme.com"
      phone: "020-7654321"
      password: "secure_password"
      parentId: 456
    }
  ) {
    contact {
      userId
      firstName
      lastName
      email
    }
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "contactRegister": {
      "contact": {
        "userId": 789,
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "jane@acme.com"
      },
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "AOEOulYnMD7FqivLPCPy2w3bXn...",
        "expirationTime": "2026-02-25T15:00:00.000Z"
      }
    }
  }
}
```

## Registering a customer (B2C)

Use `customerRegister` to create a B2C customer account. The mutation returns a session with access and refresh tokens, so the user is immediately logged in.

```graphql
mutation {
  customerRegister(
    input: {
      firstName: "John"
      lastName: "Doe"
      email: "john@example.com"
      phone: "020-1234567"
      password: "secure_password"
    }
  ) {
    session {
      accessToken
      refreshToken
      expirationTime
    }
    customer {
      ... on Customer {
        customerId
        firstName
        lastName
        email
      }
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "customerRegister": {
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "AOEOulYnMD7FqivLPCPy2w3bXn...",
        "expirationTime": "2026-02-25T15:00:00.000Z"
      },
      "customer": {
        "customerId": 12345,
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com"
      }
    }
  }
}
```

## Logging in

Use the `login` mutation to authenticate an existing user (works for both customers and contacts):

```graphql
mutation {
  login(
    input: {
      email: "john@example.com"
      password: "secure_password"
    }
  ) {
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "login": {
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "AOEOulYnMD7FqivLPCPy2w3bXn...",
        "expirationTime": "2026-02-25T15:00:00.000Z"
      }
    }
  }
}
```

The response contains:

| Field | Description |
|---|---|
| `accessToken` | Bearer token for authenticated API requests. Expires after 1 hour. |
| `refreshToken` | Token to obtain new access tokens. Does not expire unless the user is deleted, disabled or changes their password/email. |
| `expirationTime` | Timestamp when the access token expires. |

## The viewer query

After logging in, use `viewer` to retrieve the current user's details:

```graphql
query {
  viewer {
    __typename
    firstName
    middleName
    lastName
    email
    phone
    mobile
    isLoggedIn
    ... on Contact {
      userId: contactId
      company {
        companyId
        name
        addresses {
          id
          street
          number
          city
          postalCode
          country
          type
          isDefault
        }
      }
    }
    ... on Customer {
      userId: customerId
      addresses {
        id
        street
        number
        city
        postalCode
        country
        type
        isDefault
      }
    }
  }
}
```

**Expected response (for a contact):**

```json
{
  "data": {
    "viewer": {
      "__typename": "Contact",
      "firstName": "Jane",
      "middleName": null,
      "lastName": "Smith",
      "email": "jane@acme.com",
      "phone": "020-7654321",
      "mobile": null,
      "isLoggedIn": true,
      "userId": 789,
      "company": {
        "companyId": 456,
        "name": "Acme Corp",
        "addresses": [
          {
            "id": 101,
            "street": "Keizersgracht",
            "number": "100",
            "city": "Amsterdam",
            "postalCode": "1015 AA",
            "country": "NL",
            "type": "delivery",
            "isDefault": "Y"
          }
        ]
      }
    }
  }
}
```

The response type depends on who is logged in. A `Contact` is a B2B user where addresses come from the company. A `Customer` is a B2C user where addresses are on the customer directly.

Use `__typename` to determine which type and render the appropriate UI.

## Token lifecycle

### Refreshing tokens

When the access token expires, use `exchangeRefreshToken` to get a new one:

```graphql
mutation {
  exchangeRefreshToken(
    input: {
      refreshToken: "your_refresh_token"
    }
  ) {
    access_token
    refresh_token
    expires_in
    token_type
    user_id
  }
}
```

**Expected response:**

```json
{
  "data": {
    "exchangeRefreshToken": {
      "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
      "refresh_token": "AOEOulYnMD7FqivLPCPy2w3bXn...",
      "expires_in": 3600,
      "token_type": "Bearer",
      "user_id": "12345"
    }
  }
}
```

This returns a new access token and refresh token. Store them and continue making authenticated requests.

### Token expiry details

| Token | Lifetime |
|---|---|
| Access token | 3600 seconds (1 hour) |
| Refresh token | Does not expire |

Refresh tokens are invalidated when:
- The user is deleted
- The user is disabled
- The user changes their password or email

## Password reset

Generate a password reset link with `passwordResetLink`:

```graphql
mutation {
  passwordResetLink(
    input: {
      email: "john@example.com"
      redirectUrl: "https://yourstore.com/login"
      language: "en"
    }
  )
}
```

On success, this returns a reset link that you can include in a password reset email. The `redirectUrl` is where the user will be redirected after resetting their password.

## Logging out

There is no explicit logout mutation. To log a user out:

1. Remove the stored access token and refresh token from your client-side storage
2. Optionally start a new anonymous session

## Next steps

- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) for how companies, contacts and customers relate
- [Managing addresses](/frontend/domain-guides/accounts-and-authentication/managing-addresses) to manage customer and company addresses
- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) to use viewer data to pre-fill checkout addresses

---

## Favorite Lists

URL: https://docs.propeller-commerce.com/frontend/domain-guides/accounts-and-authentication/favorite-lists

# Favorite lists

Create, manage and display favorite lists using Propeller's GraphQL API. Favorite lists let users save products and clusters for quick access and reordering.

A favorite list belongs to one of three owner types:

| Owner | Field | Behavior |
|---|---|---|
| Company | `companyId` | Shared list, visible to all contacts in the company |
| Contact | `contactId` | Personal list for a specific B2B contact |
| Customer | `customerId` | Personal list for a B2C customer |

## Fetching favorite lists

Use the `favoriteLists` query to retrieve lists for a specific owner. Filter by `companyId`, `contactId` or `customerId` to scope the results.

```graphql
query GetFavoriteLists($companyId: Int, $page: Int, $offset: Int) {
  favoriteLists(
    input: {
      companyId: $companyId
      page: $page
      offset: $offset
    }
  ) {
    items {
      id
      name
      companyId
      contactId
      customerId
      isDefault
      slug
      createdAt
      updatedAt
      products {
        itemsFound
      }
      clusters {
        itemsFound
      }
    }
    itemsFound
    page
    pages
  }
}
```

**Variables:**

```json
{
  "companyId": 456,
  "page": 1,
  "offset": 10
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteLists": {
      "items": [
        {
          "id": "689615cf72635ff51c3471eb",
          "name": "Standard office supplies",
          "companyId": 456,
          "contactId": null,
          "customerId": null,
          "isDefault": true,
          "slug": "standard-office-supplies",
          "createdAt": "2026-01-15T09:30:00.000Z",
          "updatedAt": "2026-02-20T14:22:00.000Z",
          "products": {
            "itemsFound": 8
          },
          "clusters": {
            "itemsFound": 2
          }
        },
        {
          "id": "69a17974f21ab41940993034",
          "name": "Warehouse equipment",
          "companyId": 456,
          "contactId": null,
          "customerId": null,
          "isDefault": false,
          "slug": "warehouse-equipment",
          "createdAt": "2026-02-10T11:00:00.000Z",
          "updatedAt": "2026-02-27T11:01:31.000Z",
          "products": {
            "itemsFound": 3
          },
          "clusters": {
            "itemsFound": 1
          }
        }
      ],
      "itemsFound": 2,
      "page": 1,
      "pages": 1
    }
  }
}
```

The search input also supports filtering by `name`, `isDefault`, `productIds` (find lists containing specific products), `clusterIds`, `createdAt` and `lastModifiedAt` (with date range filters).

## Fetching a single list with items

Use the `favoriteList` query to retrieve a single list by ID, including its products and clusters:

```graphql
query GetFavoriteList($id: String!) {
  favoriteList(id: $id) {
    id
    name
    isDefault
    slug
    products {
      items {
        ... on Product {
          productId
          names {
            language
            value
          }
          sku
          media {
            images(search: { sort: ASC, offset: 1 }) {
              items {
                imageVariants(
                  input: {
                    transformations: [
                      {
                        name: "thumbnail"
                        transformation: {
                          width: 100
                          height: 100
                          fit: BOUNDS
                          bgColor: "transparent"
                          canvas: { width: 100, height: 100 }
                        }
                      }
                    ]
                  }
                ) {
                  name
                  url
                }
              }
            }
          }
        }
      }
      itemsFound
    }
    clusters {
      items {
        ... on Cluster {
          clusterId
          names {
            language
            value
          }
          sku
          defaultProduct {
            media {
              images(search: { sort: ASC, offset: 1 }) {
                items {
                  imageVariants(
                    input: {
                      transformations: [
                        {
                          name: "thumbnail"
                          transformation: {
                            width: 100
                            height: 100
                            fit: BOUNDS
                            bgColor: "transparent"
                            canvas: { width: 100, height: 100 }
                          }
                        }
                      ]
                    }
                  ) {
                    name
                    url
                  }
                }
              }
            }
          }
        }
      }
      itemsFound
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteList": {
      "id": "69a17974f21ab41940993034",
      "name": "Warehouse equipment",
      "isDefault": false,
      "slug": "warehouse-equipment",
      "products": {
        "items": [
          {
            "productId": 104708,
            "names": [
              {
                "language": "NL",
                "value": "Elektrische Palletwagen EP-116"
              }
            ],
            "sku": "EP-116",
            "media": {
              "images": {
                "items": [
                  {
                    "imageVariants": [
                      {
                        "name": "thumbnail",
                        "url": "https://media.helice.cloud/example/images/en/cb853191-palletwagen.jpg?bg-color=transparent&canvas=100,100&fit=bounds&height=100&width=100"
                      }
                    ]
                  }
                ]
              }
            }
          }
        ],
        "itemsFound": 3
      },
      "clusters": {
        "items": [
          {
            "clusterId": 37952,
            "names": [
              {
                "language": "NL",
                "value": "Magazijnstelling Pro 200"
              }
            ],
            "sku": "MAG-PRO-200",
            "defaultProduct": {
              "media": {
                "images": {
                  "items": [
                    {
                      "imageVariants": [
                        {
                          "name": "thumbnail",
                          "url": "https://media.helice.cloud/example/images/nl/3ecf9984-stelling.png?bg-color=transparent&canvas=100,100&fit=bounds&height=100&width=100"
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        ],
        "itemsFound": 1
      }
    }
  }
}
```

Favorite lists contain both products and clusters as separate collections. Use inline fragments (`... on Product` and `... on Cluster`) to access their fields. Both collections support their own pagination through the `input` argument.

For cluster images, access the media through `defaultProduct.media` since clusters do not have a media field directly.

> Favorite lists show products from all catalogs by default. In multi-store setups with different catalog root IDs, filter the products in the favorite list query by passing the catalog root ID to exclude products outside the current store's catalog.

## Creating a favorite list

Use `favoriteListCreate` to create a new list. Set one of `companyId`, `contactId` or `customerId` to assign ownership.

**For a company (shared list):**

```graphql
mutation {
  favoriteListCreate(
    input: {
      companyId: 456
      name: "Warehouse equipment"
      isDefault: false
    }
  ) {
    id
    name
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteListCreate": {
      "id": "69a17974f21ab41940993034",
      "name": "Warehouse equipment"
    }
  }
}
```

**For a contact (personal B2B list):**

```graphql
mutation {
  favoriteListCreate(
    input: {
      contactId: 312
      name: "Lisa's project list"
      isDefault: false
    }
  ) {
    id
    name
  }
}
```

**For a customer (B2C list):**

```graphql
mutation {
  favoriteListCreate(
    input: {
      customerId: 789
      name: "Wishlist"
      isDefault: false
    }
  ) {
    id
    name
  }
}
```

The `isDefault` field defaults to `false`. Setting it to `true` marks this as the primary list for the owner.

You can optionally include `productIds` and `clusterIds` in the create input to pre-populate the list with items on creation.

## Adding products and clusters

Use `favoriteListAddItems` to add products, clusters or both to an existing list. Items are appended to the list.

**Adding products:**

```graphql
mutation {
  favoriteListAddItems(
    id: "69a17974f21ab41940993034"
    input: {
      productIds: [104708, 104923]
    }
  ) {
    id
    products {
      itemsFound
    }
    clusters {
      itemsFound
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteListAddItems": {
      "id": "69a17974f21ab41940993034",
      "products": {
        "itemsFound": 2
      },
      "clusters": {
        "itemsFound": 0
      }
    }
  }
}
```

**Adding clusters:**

```graphql
mutation {
  favoriteListAddItems(
    id: "69a17974f21ab41940993034"
    input: {
      clusterIds: [37952]
    }
  ) {
    id
    products {
      itemsFound
    }
    clusters {
      itemsFound
    }
  }
}
```

```json
{
  "data": {
    "favoriteListAddItems": {
      "id": "69a17974f21ab41940993034",
      "products": {
        "itemsFound": 0
      },
      "clusters": {
        "itemsFound": 1
      }
    }
  }
}
```

You can add products and clusters in the same call by providing both `productIds` and `clusterIds`.

The mutation returns the updated favorite list, so you can query the full product and cluster details in the response to refresh your UI immediately.

## Removing items from a list

Use `favoriteListRemoveItems` to remove specific products or clusters from a list:

```graphql
mutation {
  favoriteListRemoveItems(
    id: "69a17974f21ab41940993034"
    input: {
      productIds: [104923]
    }
  ) {
    id
    products {
      itemsFound
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteListRemoveItems": {
      "id": "69a17974f21ab41940993034",
      "products": {
        "itemsFound": 1
      }
    }
  }
}
```

The input accepts the same structure as `favoriteListAddItems`. You can remove products, clusters or both in one call.

## Updating a favorite list

Use `favoriteListUpdate` to change the name or default status of a list:

```graphql
mutation {
  favoriteListUpdate(
    id: "69a17974f21ab41940993034"
    input: {
      name: "Main warehouse supplies"
      isDefault: true
    }
  ) {
    id
    name
    slug
    isDefault
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteListUpdate": {
      "id": "69a17974f21ab41940993034",
      "name": "Main warehouse supplies",
      "slug": "main-warehouse-supplies",
      "isDefault": true
    }
  }
}
```

The slug is automatically generated from the name.

The update input also accepts `productIds` and `clusterIds`. When provided, these replace the entire product or cluster list. This is different from `favoriteListAddItems` which appends items. Only send these fields if you intend to replace the full list contents.

## Clearing all items

Use `favoriteListClearItems` to remove all products and clusters from a list without deleting the list itself:

```graphql
mutation {
  favoriteListClearItems(id: "69a17974f21ab41940993034") {
    id
    name
    products {
      itemsFound
    }
    clusters {
      itemsFound
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "favoriteListClearItems": {
      "id": "69a17974f21ab41940993034",
      "name": "Main warehouse supplies",
      "products": {
        "itemsFound": 0
      },
      "clusters": {
        "itemsFound": 0
      }
    }
  }
}
```

## Deleting a favorite list

Use `favoriteListDelete` to permanently remove a list and all its items:

```graphql
mutation {
  favoriteListDelete(id: "69a17974f21ab41940993034")
}
```

```json
{
  "data": {
    "favoriteListDelete": true
  }
}
```

## Next steps

- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) for how the ownership model works
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) to find products to add to favorite lists
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) to add products from favorite lists to a cart
- [Fetch favorite lists with products](/frontend/recipes/fetch-favorite-lists) for a ready-to-use recipe
- [Add or remove a product from a favorite list](/frontend/recipes/manage-favorite-list-items) for a ready-to-use recipe

---

## Managing Addresses

URL: https://docs.propeller-commerce.com/frontend/domain-guides/accounts-and-authentication/managing-addresses

# Managing addresses

Retrieve, create, update and delete addresses for customers and companies using Propeller's GraphQL API.

## Retrieving addresses for the logged-in user

Use the `viewer` query to retrieve addresses for the currently authenticated user. Contacts access addresses through their company. Customers have addresses directly on their account.

```graphql
query {
  viewer {
    __typename
    ... on Contact {
      contactId
      company {
        companyId
        name
        addresses {
          id
          firstName
          lastName
          company
          street
          number
          numberExtension
          postalCode
          city
          country
          phone
          email
          type
          isDefault
          icp
          notes
        }
      }
    }
    ... on Customer {
      customerId
      addresses {
        id
        firstName
        lastName
        street
        number
        numberExtension
        postalCode
        city
        country
        phone
        email
        type
        isDefault
        notes
      }
    }
  }
}
```

**Expected response (for a contact):**

```json
{
  "data": {
    "viewer": {
      "__typename": "Contact",
      "contactId": 312,
      "company": {
        "companyId": 456,
        "name": "Brouwer Industrie",
        "addresses": [
          {
            "id": 101,
            "firstName": "Lisa",
            "lastName": "de Vries",
            "company": "Brouwer Industrie",
            "street": "Herengracht",
            "number": "42",
            "numberExtension": null,
            "postalCode": "1015 BN",
            "city": "Amsterdam",
            "country": "NL",
            "phone": "020-5551234",
            "email": "info@brouwerindustrie.nl",
            "type": "delivery",
            "isDefault": "Y",
            "icp": "N",
            "notes": null
          },
          {
            "id": 102,
            "firstName": "Lisa",
            "lastName": "de Vries",
            "company": "Brouwer Industrie",
            "street": "Industrieweg",
            "number": "88",
            "numberExtension": null,
            "postalCode": "5651 GK",
            "city": "Eindhoven",
            "country": "NL",
            "phone": "040-5559876",
            "email": "eindhoven@brouwerindustrie.nl",
            "type": "delivery",
            "isDefault": "N",
            "icp": "N",
            "notes": "Use entrance B at the back of the building"
          },
          {
            "id": 103,
            "firstName": "Lisa",
            "lastName": "de Vries",
            "company": "Brouwer Industrie",
            "street": "Herengracht",
            "number": "42",
            "numberExtension": null,
            "postalCode": "1015 BN",
            "city": "Amsterdam",
            "country": "NL",
            "phone": "020-5551234",
            "email": "finance@brouwerindustrie.nl",
            "type": "invoice",
            "isDefault": "Y",
            "icp": "N",
            "notes": null
          }
        ]
      }
    }
  }
}
```

The `addresses` field on both `Company` and `Customer` accepts two optional filters:

| Filter | Description |
|---|---|
| `type` | Filter by address type: `delivery` or `invoice`. Omit to return all types. |
| `isDefault` | Filter by default status: `Y` or `N`. |

For example, to retrieve only the default delivery address:

```graphql
addresses(type: delivery, isDefault: Y) {
  id
  street
  number
  city
  postalCode
  country
}
```

## Querying addresses directly

Use `addressesByCompanyId` or `addressesByCustomerId` to query addresses without going through the viewer. The optional `type` parameter filters by address type.

```graphql
query {
  addressesByCompanyId(companyId: 456, type: delivery) {
    id
    firstName
    lastName
    company
    street
    number
    numberExtension
    postalCode
    city
    country
    phone
    email
    type
    isDefault
    icp
  }
}
```

**Expected response:**

```json
{
  "data": {
    "addressesByCompanyId": [
      {
        "id": 101,
        "firstName": "Lisa",
        "lastName": "de Vries",
        "company": "Brouwer Industrie",
        "street": "Herengracht",
        "number": "42",
        "numberExtension": null,
        "postalCode": "1015 BN",
        "city": "Amsterdam",
        "country": "NL",
        "phone": "020-5551234",
        "email": "info@brouwerindustrie.nl",
        "type": "delivery",
        "isDefault": "Y",
        "icp": "N"
      },
      {
        "id": 102,
        "firstName": "Lisa",
        "lastName": "de Vries",
        "company": "Brouwer Industrie",
        "street": "Industrieweg",
        "number": "88",
        "numberExtension": null,
        "postalCode": "5651 GK",
        "city": "Eindhoven",
        "country": "NL",
        "phone": "040-5559876",
        "email": "eindhoven@brouwerindustrie.nl",
        "type": "delivery",
        "isDefault": "N",
        "icp": "N"
      }
    ]
  }
}
```

Omit the `type` parameter to return all addresses regardless of type.

`addressesByCustomerId` works the same way, with `customerId` instead of `companyId`.

## Creating a company address

Use `companyAddressCreate` to add an address to a company:

```graphql
mutation {
  companyAddressCreate(
    input: {
      companyId: 456
      type: delivery
      firstName: "Tom"
      lastName: "Hendriks"
      company: "Brouwer Industrie"
      street: "Prinsengracht"
      number: "200"
      postalCode: "1016 HC"
      city: "Amsterdam"
      country: "NL"
      phone: "020-5554567"
      email: "amsterdam-west@brouwerindustrie.nl"
      isDefault: N
      notes: "Ring bell twice"
    }
  ) {
    id
    firstName
    lastName
    company
    street
    number
    postalCode
    city
    country
    phone
    email
    type
    isDefault
  }
}
```

**Expected response:**

```json
{
  "data": {
    "companyAddressCreate": {
      "id": 104,
      "firstName": "Tom",
      "lastName": "Hendriks",
      "company": "Brouwer Industrie",
      "street": "Prinsengracht",
      "number": "200",
      "postalCode": "1016 HC",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "020-5554567",
      "email": "amsterdam-west@brouwerindustrie.nl",
      "type": "delivery",
      "isDefault": "N"
    }
  }
}
```

The required fields are:

| Field | Description |
|---|---|
| `companyId` | The company to add the address to |
| `type` | Address type: `delivery` or `invoice`. |
| `street` | Street name |
| `postalCode` | Postal code |
| `city` | City |
| `country` | Country code (e.g. `NL`, `DE`, `BE`) |

All other fields are optional. When `isDefault` is omitted, the address is not set as default. Setting `isDefault` to `Y` makes this the default address for its type within the company.

The `icp` field controls whether tax is applied when this address is selected as a delivery address. Set it to `Y` for intra-community B2B shipments within the EU where the reverse charge mechanism applies.

## Creating a customer address

Use `customerAddressCreate` to add an address to a customer account:

```graphql
mutation {
  customerAddressCreate(
    input: {
      customerId: 789
      type: delivery
      firstName: "Sophie"
      lastName: "van Dijk"
      street: "Vondelstraat"
      number: "15"
      numberExtension: "A"
      postalCode: "1054 GD"
      city: "Amsterdam"
      country: "NL"
      phone: "020-5557890"
      email: "sophie@example.com"
    }
  ) {
    id
    firstName
    lastName
    street
    number
    numberExtension
    postalCode
    city
    country
    phone
    email
    type
    isDefault
  }
}
```

**Expected response:**

```json
{
  "data": {
    "customerAddressCreate": {
      "id": 201,
      "firstName": "Sophie",
      "lastName": "van Dijk",
      "street": "Vondelstraat",
      "number": "15",
      "numberExtension": "A",
      "postalCode": "1054 GD",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "020-5557890",
      "email": "sophie@example.com",
      "type": "delivery",
      "isDefault": "N"
    }
  }
}
```

The required fields are the same as for company addresses: `customerId`, `type`, `street`, `postalCode`, `city` and `country`.

## Updating an address

Use `companyAddressUpdate` to modify an existing company address. Only send the fields you want to change. Fields you omit keep their current values.

```graphql
mutation {
  companyAddressUpdate(
    input: {
      id: 102
      companyId: 456
      street: "Kanaaldijk"
      number: "12"
      postalCode: "5683 CR"
      city: "Best"
    }
  ) {
    id
    street
    number
    postalCode
    city
    country
    type
    isDefault
  }
}
```

**Expected response:**

```json
{
  "data": {
    "companyAddressUpdate": {
      "id": 102,
      "street": "Kanaaldijk",
      "number": "12",
      "postalCode": "5683 CR",
      "city": "Best",
      "country": "NL",
      "type": "delivery",
      "isDefault": "N"
    }
  }
}
```

The `id` and `companyId` fields are required. All other fields are optional.

The `type` field cannot be changed after creation. To change an address from delivery to invoice, delete it and create a new one with the correct type.

`customerAddressUpdate` works the same way, using `customerId` instead of `companyId`.

## Deleting an address

Use `companyAddressDelete` to remove a company address:

```graphql
mutation {
  companyAddressDelete(
    input: {
      id: 104
      companyId: 456
    }
  )
}
```

```json
{
  "data": {
    "companyAddressDelete": true
  }
}
```

`customerAddressDelete` works the same way, using `customerId` instead of `companyId`.

## Handling both user types

Your frontend needs to handle both contacts (B2B) and customers (B2C). Use the `__typename` from the `viewer` query to determine which mutations to call:

| User type | `__typename` | Mutations | Identifier |
|---|---|---|---|
| Contact (B2B) | `Contact` | `companyAddressCreate`, `companyAddressUpdate`, `companyAddressDelete` | `companyId` from `viewer.company` |
| Customer (B2C) | `Customer` | `customerAddressCreate`, `customerAddressUpdate`, `customerAddressDelete` | `customerId` from `viewer` |

Contacts manage addresses at the company level. Any changes to company addresses are visible to all contacts within that company.

## Next steps

- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) for how companies, contacts and customers relate
- [Authentication and authorization](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization) for registration, login and token management
- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) to use stored addresses during checkout

---

## Understanding Companies, Contacts and Customers

URL: https://docs.propeller-commerce.com/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers

# Understanding companies, contacts and customers

Propeller uses three account entities to model B2B and B2C relationships. **Companies** and **contacts** are used for B2B. **Customers** are used for B2C. Understanding how they relate helps you build registration, checkout and account management features correctly.

## Companies

A company is the B2B entity, identified by `companyId`. A company represents a business organization with its own financial details, addresses and users.

| Field | Description |
|---|---|
| `name` | Company name |
| `email`, `phone` | Company contact details |
| `taxNumber` | VAT / tax registration number |
| `cocNumber` | Chamber of Commerce number |
| `debtorId` | Financial identifier for invoicing |
| `notes` | Internal notes |
| `slug` | URL-friendly identifier |
| `tag` | Custom tag for grouping or classification |
| `hidden` | Whether the company should only be used for background operations (Y/N) |

A company has **contacts** (the people who operate within it), **addresses** (delivery and invoice) and optionally **managers** (account managers assigned to the company).

## Contacts

A contact is a B2B user entity, identified by `contactId`. A contact is a person who operates within the context of one or more companies.

Contacts carry personal fields (firstName, middleName, lastName, email, phone, mobile, gender, dateOfBirth, primaryLanguage, login) plus B2B-specific fields:

| Field | Description |
|---|---|
| `parentCompanyId` | The primary company this contact belongs to |
| `company` | The primary company entity |
| `companies` | All companies the contact belongs to |
| `managedCompanies` | Companies where this contact is an account manager |

### Contacts in multiple companies

A contact can belong to multiple companies. Each company relationship is independent, with its own purchase authorization role and spending limit.

For example, a single contact might belong to three companies:

```
Contact: Lisa de Vries
├── Brouwer Industrie NL   (AUTHORIZATION_MANAGER, no spending limit)
├── Brouwer Industrie DE
└── Brouwer Industrie US
```

When a contact places an order, the order is associated with both the contact and the company they are ordering for.

## Customers

A customer is the B2C user entity, identified by `customerId`. Customers are standalone accounts that do not belong to a company.

Each customer carries personal details and their own account data:

| Field | Description |
|---|---|
| `firstName`, `middleName`, `lastName` | Full name |
| `email` | Email address |
| `phone`, `mobile` | Phone numbers |
| `gender` | M, F or U (unknown) |
| `dateOfBirth` | Date of birth |
| `primaryLanguage` | Preferred language |
| `login` | The email used for authentication. When null, no account has been linked yet |
| `debtorId` | Financial identifier for invoicing |
| `expires` | Optional expiration date. After this date the account is disabled |
| `mailingList` | Whether the customer is subscribed to mailings (Y/N) |

Customers have their own addresses (delivery and invoice) and their own order history.

## Addresses

Companies and customers have addresses. Contacts do not have their own addresses. They use the addresses of the company they are ordering for.

There are two address types: `delivery` and `invoice`.

Each address includes:

| Field | Description |
|---|---|
| `street`, `number`, `numberExtension` | Street address |
| `postalCode`, `city`, `region`, `country` | Location |
| `firstName`, `middleName`, `lastName`, `gender` | Addressee |
| `company` | Company name on the address |
| `phone`, `mobile`, `email` | Contact details |
| `isDefault` | Whether this is the default address for its type (Y/N) |
| `type` | delivery or invoice |
| `active` | Whether the address is active (Y/N) |
| `icp` | Intra-Community Performance flag (Y/N). Used for B2B cross-border orders to determine whether tax should be applied |
| `code`, `notes`, `name` | Custom code, delivery notes and a friendly descriptive name |

A company can have multiple addresses per type. For example, a company might have two delivery addresses at different locations, with one marked as default.

## Purchase authorization

Purchase authorization controls what contacts are allowed to order within a company. Each contact-company relationship has a `PurchaseAuthorizationConfig` that defines a role and an optional spending limit.

### Roles

| Role | Description |
|---|---|
| `PURCHASER` | Default role. Can place orders but is subject to an authorization limit per order. When the order total exceeds the limit, the order cannot be completed without approval from an authorization manager |
| `AUTHORIZATION_MANAGER` | Manages authorization limits and purchase requests for purchasers. Has no spending limit |

### Authorization limit

The `authorizationLimit` field sets the maximum amount a purchaser can spend per order. When null (for authorization managers), there is no limit.

A contact has a separate configuration per company they belong to. This means the same person can have different roles and limits at different companies.

For example, within a single company:

```
Brouwer Industrie NL
├── Lisa de Vries         — AUTHORIZATION_MANAGER (no limit)
├── Tom Hendriks          — PURCHASER (limit: €0, all orders require approval)
├── Eva Mulder            — PURCHASER (limit: €250)
└── Jan Brouwer            — no config (no limit)
```

When Eva places an order above €250, it requires authorization from Lisa before it can be processed. Contacts without a purchase authorization config, like Jan, can order without restrictions.

## How this relates to orderlists

Orderlists are customer-specific catalogs that control which products and clusters are visible and orderable for specific accounts. An orderlist can be assigned to companies or individual users (contacts or customers). Each orderlist has a code, descriptions, optional validity dates (`validFrom`, `validTo`) and an active flag.

When an orderlist is assigned, only the products and clusters in that list are available to the account.

## How this relates to pricesheets

Pricesheets provide customer-specific pricing. A pricesheet can be assigned to companies, contacts or customers. Each pricesheet has a code, localized names and descriptions, a priority (to determine which applies when multiple match) and a readonly flag.

For example, a company might have a "Premium customers" pricesheet assigned at the company level, giving all contacts within that company access to special pricing.

For the full pricing model, see [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers).

## How this relates to favorite lists

Favorite lists let users save collections of products and clusters for quick reordering. A favorite list can belong to a company (`companyId`), a contact (`contactId`) or a customer (`customerId`).

Company-level lists are shared across all contacts in that company. Contact-level and customer-level lists are personal.

For example, a company might have a shared list for commonly ordered supplies, while individual contacts maintain their own lists for specific projects.

For practical details, see [Favorite lists](/frontend/domain-guides/accounts-and-authentication/favorite-lists).

## How this relates to attributes

Companies, contacts and customers can all have attributes. The attribute system works the same way as for products: each attribute is defined by an `attributeDescription` with a name, type, group and behavior flags.

Company attributes might store business-specific data like payment possibilities or business type classifications. Contact attributes might control ordering behavior, such as whether a contact can only order via quotes or has a budget restriction.

System attributes (where `isSystem` is true and `isHidden` is true) are used internally for features like user group assignments and are not meant to be displayed to end users.

---

## Cart Management

URL: https://docs.propeller-commerce.com/frontend/domain-guides/cart-and-checkout/cart-management

# Cart management

Create and manage shopping carts using Propeller's GraphQL API. Add items, update quantities, apply discount codes, fetch totals and handle cart persistence across sessions. Propeller calculates all pricing, discounts and taxes server-side.

## Creating a cart

Use `cartStart` to create a new cart. The mutation returns the full `Cart` object including a `cartId` (UUID) that you need for all subsequent operations.

**For a B2B contact:**

```graphql
mutation {
  cartStart(
    input: {
      contactId: 312
      companyId: 456
    }
  ) {
    cartId
    contactId
    companyId
    createdAt
  }
}
```

Expected response:

```json
{
  "data": {
    "cartStart": {
      "cartId": "019abc12-3456-7def-8901-234567890abc",
      "contactId": 312,
      "companyId": 456,
      "createdAt": "2026-02-27T10:15:00.000Z"
    }
  }
}
```

**For a B2C customer:**

```graphql
mutation {
  cartStart(
    input: {
      customerId: 789
    }
  ) {
    cartId
    customerId
    createdAt
  }
}
```

**For a guest user:**

```graphql
mutation {
  cartStart {
    cartId
    createdAt
  }
}
```

Omit all IDs to create a guest cart. You can associate it with a user later using `cartSetContact` or `cartSetCustomer` (see [Changing cart ownership](#changing-cart-ownership)).

Store the `cartId` in your application state or `localStorage`. Every cart operation requires it.

## Adding items

Use `cartAddItem` to add a product to the cart:

```graphql
mutation {
  cartAddItem(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      productId: 104708
      quantity: 3
    }
  ) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartAddItem": {
      "items": [
        {
          "itemId": "019abc13-1a2b-7c3d-4e5f-678901234567",
          "productId": 104708,
          "quantity": 3,
          "price": 24.50,
          "priceNet": 29.65,
          "totalPrice": 73.50,
          "totalPriceNet": 88.94
        }
      ],
      "total": {
        "subTotal": 73.50,
        "subTotalNet": 88.94,
        "totalGross": 73.50,
        "totalNet": 88.94
      }
    }
  }
}
```

The `input` accepts these fields:

| Field | Type | Description |
|---|---|---|
| `productId` | `Int!` | Product to add (required) |
| `quantity` | `Int` | Number of units. Defaults to `1` |
| `clusterId` | `Int` | Cluster the product belongs to, if applicable |
| `notes` | `String` | Item-level notes (e.g., special instructions) |
| `price` | `Float` | Custom unit price. Overrides platform pricing when set |
| `childItems` | `[CartChildItemInput!]` | Child items for configurable clusters |

The response includes an `itemId` for each cart item. You need this ID for updating or deleting the item later.

If the product has `minimumQuantity` or `purchaseUnit` constraints, the API rejects quantities that violate these rules.

### Adding items with child items

For configurable clusters where a main product has selectable options (e.g., a workstation with monitors and peripherals), pass `childItems`:

```graphql
mutation {
  cartAddItem(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      productId: 104900
      clusterId: 2150
      quantity: 1
      childItems: [
        { productId: 104901, quantity: 1 }
        { productId: 104902, quantity: 2 }
      ]
    }
  ) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
      childItems {
        itemId
        productId
        quantity
        price
        priceNet
      }
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartAddItem": {
      "items": [
        {
          "itemId": "019abc15-3c4d-7e5f-6071-890123456789",
          "productId": 104900,
          "quantity": 1,
          "price": 500,
          "priceNet": 605,
          "childItems": [
            {
              "itemId": "019abc15-3c4d-7e5f-6071-890123456790",
              "productId": 104901,
              "quantity": 1,
              "price": 0,
              "priceNet": 0
            },
            {
              "itemId": "019abc15-3c4d-7e5f-6071-890123456791",
              "productId": 104902,
              "quantity": 2,
              "price": 0,
              "priceNet": 0
            }
          ]
        }
      ]
    }
  }
}
```

Each child item accepts `productId` (required), `quantity` (defaults to 1), `notes` and `price`.

### Adding bundles

Use `cartAddBundle` to add a predefined product bundle:

```graphql
mutation {
  cartAddBundle(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      bundleId: "019c9425-5eaf-72b5-9315-d7182932db45"
      quantity: 1
    }
  ) {
    items {
      itemId
      productId
      bundleId
      quantity
      price
      priceNet
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartAddBundle": {
      "items": [
        {
          "itemId": "019ca0f6-faba-7e17-88fd-afb653794297",
          "productId": 2017,
          "bundleId": "019c9425-5eaf-72b5-9315-d7182932db45",
          "quantity": 1,
          "price": 270.885,
          "priceNet": 327.77
        }
      ]
    }
  }
}
```

The `input` accepts `bundleId` (required), `quantity` (defaults to 1) and `notes`.

### Bulk item operations

Use `cartItemBulk` to add or update multiple items in a single call:

```graphql
mutation {
  cartItemBulk(
    input: {
      cartId: "019abc12-3456-7def-8901-234567890abc"
      items: [
        { productId: 104708, quantity: 5 }
        { productId: 104923, quantity: 2 }
        { itemId: "019abc13-1a2b-7c3d-4e5f-678901234567", quantity: 10 }
      ]
    }
  ) {
    created
    updated
    total
  }
}
```

Expected response:

```json
{
  "data": {
    "cartItemBulk": {
      "created": 2,
      "updated": 1,
      "total": 3
    }
  }
}
```

Unlike other cart mutations, the `cartId` is inside the input object. Each item can use `productId` to create a new line or `itemId` to update an existing one.

`cartItemBulk` is particularly useful for B2B workflows like reordering, where a buyer adds dozens of items at once from a previous order or an imported product list.

## Updating items

Use `cartUpdateItem` to change the quantity, notes or price of an existing item. Note the three separate arguments: `id` (cart), `itemId` (item) and `input`:

```graphql
mutation {
  cartUpdateItem(
    id: "019abc12-3456-7def-8901-234567890abc"
    itemId: "019abc13-1a2b-7c3d-4e5f-678901234567"
    input: {
      quantity: 5
      notes: "Deliver to warehouse B"
    }
  ) {
    items {
      itemId
      productId
      quantity
      notes
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    total {
      totalGross
      totalNet
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartUpdateItem": {
      "items": [
        {
          "itemId": "019abc13-1a2b-7c3d-4e5f-678901234567",
          "productId": 104708,
          "quantity": 5,
          "notes": "Deliver to warehouse B",
          "price": 24.50,
          "priceNet": 29.65,
          "totalPrice": 122.50,
          "totalPriceNet": 148.23
        }
      ],
      "total": {
        "totalGross": 122.50,
        "totalNet": 148.23
      }
    }
  }
}
```

The `input` accepts `quantity` (defaults to 1), `notes` and `price` (custom unit price override).

## Removing items

Use `cartDeleteItem` to remove an item from the cart:

```graphql
mutation {
  cartDeleteItem(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      itemId: "019abc13-1a2b-7c3d-4e5f-678901234567"
    }
  ) {
    items {
      itemId
      productId
      quantity
    }
    total {
      totalGross
      totalNet
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartDeleteItem": {
      "items": [],
      "total": {
        "totalGross": 0,
        "totalNet": 0
      }
    }
  }
}
```

## Fetching cart state

Use the `cart` query to retrieve the full cart at any point:

```graphql
query {
  cart(id: "019abc12-3456-7def-8901-234567890abc") {
    cartId
    contactId
    companyId
    customerId
    notes
    reference
    actionCode
    status
    createdAt
    lastModifiedAt
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
      discount
      discountNet
      discountPercentage
    }
    taxLevels {
      taxPercentage
      price
    }
    items {
      itemId
      productId
      clusterId
      quantity
      notes
      price
      priceNet
      totalPrice
      totalPriceNet
      sum
      sumNet
      totalSum
      totalSumNet
      discount
      discountPercentage
      taxCode
      childItems {
        itemId
        productId
        quantity
        price
        priceNet
      }
    }
    bonusItems {
      itemId
      productId
      quantity
      totalPrice
      totalPriceNet
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cart": {
      "cartId": "019abc12-3456-7def-8901-234567890abc",
      "contactId": 312,
      "companyId": 456,
      "customerId": null,
      "notes": "",
      "reference": "PO-2026-0042",
      "actionCode": "",
      "status": "OPEN",
      "createdAt": "2026-02-27T10:15:00.000Z",
      "lastModifiedAt": "2026-02-27T11:30:00.000Z",
      "total": {
        "subTotal": 196.00,
        "subTotalNet": 237.16,
        "totalGross": 196.00,
        "totalNet": 237.16,
        "discount": 0,
        "discountNet": 0,
        "discountPercentage": 0
      },
      "taxLevels": [
        {
          "taxPercentage": 21,
          "price": 41.16
        }
      ],
      "items": [
        {
          "itemId": "019abc13-1a2b-7c3d-4e5f-678901234567",
          "productId": 104708,
          "clusterId": null,
          "quantity": 5,
          "notes": "Deliver to warehouse B",
          "price": 24.50,
          "priceNet": 29.65,
          "totalPrice": 122.50,
          "totalPriceNet": 148.23,
          "sum": 24.50,
          "sumNet": 29.65,
          "totalSum": 122.50,
          "totalSumNet": 148.23,
          "discount": 0,
          "discountPercentage": 0,
          "taxCode": "H",
          "childItems": []
        },
        {
          "itemId": "019abc14-2b3c-7d4e-5f60-789012345678",
          "productId": 104923,
          "clusterId": null,
          "quantity": 2,
          "notes": "",
          "price": 36.75,
          "priceNet": 44.47,
          "totalPrice": 73.50,
          "totalPriceNet": 88.94,
          "sum": 36.75,
          "sumNet": 44.47,
          "totalSum": 73.50,
          "totalSumNet": 88.94,
          "discount": 0,
          "discountPercentage": 0,
          "taxCode": "H",
          "childItems": []
        }
      ],
      "bonusItems": []
    }
  }
}
```

The cart also has fields for `invoiceAddress`, `deliveryAddress`, `paymentData`, `postageData`, `payMethods`, `carriers` and `shippingMethods`. These are used during checkout and documented in [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow).

### Understanding totals

Propeller calculates all totals server-side. You do not need to compute anything in your frontend.

| Field | Description |
|---|---|
| `subTotal` | Sum of all items, excluding shipping, payment costs and discounts. Excluding VAT |
| `subTotalNet` | Same as above, including VAT |
| `totalGross` | Final payable amount, excluding VAT |
| `totalNet` | Final payable amount, including VAT |
| `discount` | Discount applied through incentives, excluding VAT |
| `discountNet` | Discount applied through incentives, including VAT |
| `discountPercentage` | Discount percentage applied through incentives |

The `taxLevels` array breaks down tax amounts per tax rate. This is useful when multiple VAT rates apply (e.g., standard 21% and reduced 9%).

> **Naming convention:** Throughout the cart API, "Net" means **including VAT** and "Gross" means **excluding VAT**. The `price` field on items is always excluding VAT and `priceNet` is including VAT. This convention is consistent across the entire API.

### Understanding item prices

Each cart item has several price fields:

| Field | Description |
|---|---|
| `price` / `priceNet` | Unit price excluding / including VAT |
| `totalPrice` / `totalPriceNet` | Total for this item after item-specific discounts |
| `sum` / `sumNet` | Unit price including child item prices, before item discounts |
| `totalSum` / `totalSumNet` | Final total including child items, quantity and discounts |

For items without child items, `price` equals `sum` and `totalPrice` equals `totalSum`. The `sum` fields become relevant when you use configurable clusters with child items.

## Applying discount codes

Use `cartAddActionCode` to apply a discount code (called an "action code" in Propeller):

```graphql
mutation {
  cartAddActionCode(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      actionCode: "EXTRASALE10"
    }
  ) {
    actionCode
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
      discount
      discountNet
      discountPercentage
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartAddActionCode": {
      "actionCode": "EXTRASALE10",
      "total": {
        "subTotal": 270.885,
        "subTotalNet": 327.77,
        "totalGross": 315.885,
        "totalNet": 382.22,
        "discount": 10,
        "discountNet": 12.10,
        "discountPercentage": 3.69
      }
    }
  }
}
```

The `actionCode` field on the cart is only filled when the code is valid. If the code does not exist or has expired, the mutation returns an error.

Remove a discount code with `cartRemoveActionCode`:

```graphql
mutation {
  cartRemoveActionCode(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      actionCode: "EXTRASALE10"
    }
  ) {
    actionCode
    total {
      totalGross
      totalNet
      discount
      discountPercentage
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "cartRemoveActionCode": {
      "actionCode": "",
      "total": {
        "totalGross": 325.885,
        "totalNet": 394.32,
        "discount": 0,
        "discountPercentage": 0
      }
    }
  }
}
```

Both mutations use the same input type (`CartActionCodeInput`).

## Updating cart details

Use `cartUpdate` to set notes, a reference number or custom fields on the cart:

```graphql
mutation {
  cartUpdate(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      notes: "Please deliver before 14:00"
      reference: "PO-2026-0042"
    }
  ) {
    notes
    reference
  }
}
```

Expected response:

```json
{
  "data": {
    "cartUpdate": {
      "notes": "Please deliver before 14:00",
      "reference": "PO-2026-0042"
    }
  }
}
```

The `input` also accepts `extra3` and `extra4` for additional custom data. All of these fields persist to the order after checkout.

The `reference` field is typically used by B2B buyers to store their internal purchase order (PO) number. Companies require PO numbers on orders so they can match invoices to approved purchase requests in their financial system. For B2C, this field is rarely used.

The `cartUpdate` mutation is also used for setting shipping and payment data during checkout. See [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) for those operations.

## Changing cart ownership

To associate a guest cart with a user after login, use `cartSetContact` (B2B) or `cartSetCustomer` (B2C):

```graphql
mutation {
  cartSetContact(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      contactId: 312
      companyId: 456
    }
  ) {
    cartId
    contactId
    companyId
  }
}
```

```graphql
mutation {
  cartSetCustomer(
    id: "019abc12-3456-7def-8901-234567890abc"
    input: {
      customerId: 789
    }
  ) {
    cartId
    customerId
  }
}
```

For `cartSetContact`, the `companyId` is optional and defaults to the contact's parent company.

## Deleting a cart

Use `cartDelete` to permanently remove a cart:

```graphql
mutation {
  cartDelete(id: "019abc12-3456-7def-8901-234567890abc")
}
```

Expected response:

```json
{
  "data": {
    "cartDelete": true
  }
}
```

Returns `true` on success.

## Cart persistence

### Guest users

For unauthenticated users, store the `cartId` locally after calling `cartStart`. After calling `cartStart`, store the returned `cartId` in browser storage (for example `localStorage`). This is the only value you need to persist on the client side.

On page load, retrieve the stored `cartId` and use it with the `cart` query to restore the cart state.

After order completion, clear the stored `cartId`.

Cart items persist server-side in Propeller. Only the `cartId` reference needs to be stored locally. Checkout data (addresses, payment, shipping) is retained for 30 days.

### Authenticated users

For logged-in users, retrieve all their carts with the `carts` query:

```graphql
query {
  carts(
    input: {
      contactIds: [312]
      companyIds: [456]
    }
  ) {
    items {
      cartId
      createdAt
      lastModifiedAt
      items {
        itemId
        productId
        quantity
      }
      total {
        totalGross
        totalNet
      }
    }
    itemsFound
    page
    pages
  }
}
```

Expected response:

```json
{
  "data": {
    "carts": {
      "items": [
        {
          "cartId": "019abc12-3456-7def-8901-234567890abc",
          "createdAt": "2026-02-27T10:15:00.000Z",
          "lastModifiedAt": "2026-02-27T11:30:00.000Z",
          "items": [
            {
              "itemId": "019abc13-1a2b-7c3d-4e5f-678901234567",
              "productId": 104708,
              "quantity": 5
            }
          ],
          "total": {
            "totalGross": 122.50,
            "totalNet": 148.23
          }
        }
      ],
      "itemsFound": 1,
      "page": 1,
      "pages": 1
    }
  }
}
```

The `CartSearchInput` supports these filters:

| Field | Type | Description |
|---|---|---|
| `ids` | `[String!]` | Filter by specific cart IDs |
| `contactIds` | `[Int!]` | Filter by contact IDs |
| `customerIds` | `[Int!]` | Filter by customer IDs |
| `companyIds` | `[Int!]` | Filter by company IDs |
| `statuses` | `[CartStatus!]` | Filter by cart status (`OPEN` or `PENDING_PURCHASE_AUTHORIZATION`) |
| `createdAt` | `DateSearchInput` | Filter by creation date range |
| `lastModifiedAt` | `DateSearchInput` | Filter by last modification date range |
| `page` | `Int` | Page number (defaults to 1) |
| `offset` | `Int` | Items per page (defaults to 12) |
| `sortInputs` | `[CartSortInput!]` | Sort by `ID`, `LAST_MODIFIED_AT` or `CREATED_AT` |

### Guest-to-authenticated transition

When a guest user logs in, you may need to merge their guest cart with an existing authenticated cart:

1. Retrieve the guest `cartId` from `localStorage`
2. Query the authenticated user's carts with the `carts` query
3. If the user has an existing cart, merge items using `cartAddItem` on the authenticated cart. Alternatively, associate the guest cart with the user using `cartSetContact` or `cartSetCustomer`
4. Update `localStorage` with the active `cartId`

## Multiple carts

Propeller supports multiple active carts per user. Each cart has its own `cartId` and operates independently. In B2B, buyers often manage separate carts for different departments, cost centers or projects within their organization. Each cart maps to a different budget line or internal approval path. Common use cases include:

- **Project carts** for different departments or purchase orders
- **Saved carts** that users want to complete later
- **Quick-order carts** for recurring purchases

Create additional carts with `cartStart` and switch between them by using the appropriate `cartId` in your queries and mutations. Use the `carts` query to list all carts for a user.

## Error handling

Cart mutations return errors in the GraphQL response `errors` array. Common errors include:

| Error | Cause |
|---|---|
| Cart not found | Invalid or expired `cartId` |
| Product not found | Invalid `productId` |
| Cart item not found | Invalid `itemId` |
| Pricing information not found | Product has no price configured |
| Invalid action code | Discount code does not exist or has expired |

## Next steps

- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) for setting addresses, shipping, payment and creating the order
- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) for how price sheets affect cart totals
- [Add a product to cart](/frontend/recipes/add-product-to-cart) for a ready-to-use recipe
- [Fetch cart with totals](/frontend/recipes/fetch-cart-with-totals) for a ready-to-use recipe

---

## Checkout Flow

URL: https://docs.propeller-commerce.com/frontend/domain-guides/cart-and-checkout/checkout-flow

# Checkout flow

Set addresses, shipping and payment on a cart, review the order and convert it into a Propeller order using `cartProcess`. This page picks up where [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) leaves off (you already have a cart with items) and ends when the order is created. For payment processing after order creation, see [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration).

## Guest, B2C and B2B checkout

The checkout flow works for three types of users. The main difference is where address data comes from.

| Scenario | User type | Address source | Prefill possible |
|---|---|---|---|
| Guest | None (anonymous cart) | Manual entry | No |
| B2C | `Customer` | `customer.addresses` | Yes |
| B2B | `Contact` | `contact.company.addresses` | Yes |

For guest checkout, the user must enter all address fields manually. For logged-in users (B2C customers or B2B contacts), you can prefill addresses from their account data.

## Prefilling addresses for logged-in users

Use the `viewer` query to fetch the current user's details and stored addresses. The query returns either a `Contact` (B2B) or a `Customer` (B2C), determined by `__typename`.

### Query

```graphql
query {
  viewer {
    __typename
    firstName
    middleName
    lastName
    email
    phone
    mobile
    ... on Contact {
      contactId
      company {
        companyId
        name
        addresses {
          id
          firstName
          middleName
          lastName
          company
          street
          number
          numberExtension
          postalCode
          city
          country
          email
          phone
          type
          isDefault
          icp
          notes
        }
      }
    }
    ... on Customer {
      customerId
      addresses {
        id
        firstName
        middleName
        lastName
        street
        number
        numberExtension
        postalCode
        city
        country
        email
        phone
        type
        isDefault
        icp
        notes
      }
    }
  }
}
```

### Response

```json
{
  "data": {
    "viewer": {
      "__typename": "Contact",
      "firstName": "Sophie",
      "middleName": "van",
      "lastName": "Dijk",
      "email": "sophie@brouwerindustrie.nl",
      "phone": "+31201234567",
      "mobile": "+31612345678",
      "contactId": 42,
      "company": {
        "companyId": 10,
        "name": "Brouwer Industrie",
        "addresses": [
          {
            "id": 101,
            "firstName": "Sophie",
            "middleName": "van",
            "lastName": "Dijk",
            "company": "Brouwer Industrie",
            "street": "Keizersgracht",
            "number": "452",
            "numberExtension": null,
            "postalCode": "1016 GE",
            "city": "Amsterdam",
            "country": "NL",
            "email": "sophie@brouwerindustrie.nl",
            "phone": "+31201234567",
            "type": "delivery",
            "isDefault": "Y",
            "icp": "N",
            "notes": null
          },
          {
            "id": 102,
            "firstName": "Sophie",
            "middleName": "van",
            "lastName": "Dijk",
            "company": "Brouwer Industrie",
            "street": "Herengracht",
            "number": "100",
            "numberExtension": "A",
            "postalCode": "1015 BS",
            "city": "Amsterdam",
            "country": "NL",
            "email": "finance@brouwerindustrie.nl",
            "phone": "+31201234567",
            "type": "invoice",
            "isDefault": "Y",
            "icp": "N",
            "notes": null
          }
        ]
      }
    }
  }
}
```

### How it works

For a `Contact`, addresses come from the company (`contact.company.addresses`). For a `Customer`, addresses are on the customer directly (`customer.addresses`). Use the `type` field (`delivery` or `invoice`) and the `isDefault` field to pre-select the appropriate address for each step of checkout.

A company can have multiple addresses of the same type. For example, a company with two warehouses might have two delivery addresses. Present all addresses to the user and pre-select the one where `isDefault` is `Y`.

> The `type` field on user addresses uses lowercase values (`delivery`, `invoice`), while the `CartAddressType` enum used in `cartUpdateAddress` uses uppercase values (`DELIVERY`, `INVOICE`). Map between these when prefilling.

## Setting addresses

Use `cartUpdateAddress` to set the delivery and invoice addresses on the cart. Call this mutation twice: once for each address type.

### Set the delivery address

#### Mutation

```graphql
mutation SetDeliveryAddress($cartId: String!) {
  cartUpdateAddress(
    id: $cartId
    input: {
      type: DELIVERY
      company: "Brouwer Industrie"
      firstName: "Sophie"
      middleName: "van"
      lastName: "Dijk"
      street: "Keizersgracht"
      number: "452"
      postalCode: "1016 GE"
      city: "Amsterdam"
      country: "NL"
      email: "sophie@brouwerindustrie.nl"
      phone: "+31201234567"
    }
  ) {
    deliveryAddress {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      country
      email
      phone
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cartUpdateAddress": {
      "deliveryAddress": {
        "firstName": "Sophie",
        "middleName": "van",
        "lastName": "Dijk",
        "company": "Brouwer Industrie",
        "street": "Keizersgracht",
        "number": "452",
        "numberExtension": null,
        "postalCode": "1016 GE",
        "city": "Amsterdam",
        "country": "NL",
        "email": "sophie@brouwerindustrie.nl",
        "phone": "+31201234567"
      }
    }
  }
}
```

### Set the invoice address

#### Mutation

```graphql
mutation SetInvoiceAddress($cartId: String!) {
  cartUpdateAddress(
    id: $cartId
    input: {
      type: INVOICE
      company: "Brouwer Industrie"
      firstName: "Sophie"
      middleName: "van"
      lastName: "Dijk"
      street: "Herengracht"
      number: "100"
      numberExtension: "A"
      postalCode: "1015 BS"
      city: "Amsterdam"
      country: "NL"
      email: "finance@brouwerindustrie.nl"
      phone: "+31201234567"
    }
  ) {
    invoiceAddress {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      country
      email
      phone
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cartUpdateAddress": {
      "invoiceAddress": {
        "firstName": "Sophie",
        "middleName": "van",
        "lastName": "Dijk",
        "company": "Brouwer Industrie",
        "street": "Herengracht",
        "number": "100",
        "numberExtension": "A",
        "postalCode": "1015 BS",
        "city": "Amsterdam",
        "country": "NL",
        "email": "finance@brouwerindustrie.nl",
        "phone": "+31201234567"
      }
    }
  }
}
```

### How it works

The `type` field determines which address you are setting: `DELIVERY` for shipping or `INVOICE` for billing. Both mutations return the full cart, so you can request either or both address objects in the response to confirm the update.

Required fields are `type`, `firstName`, `lastName`, `street`, `postalCode` and `city`. The `country` field defaults to `"NL"` if not provided. The `icp` field (Intra-Community Performance) defaults to `N` and controls whether tax is applied for B2B cross-border orders within the EU.

Propeller recalculates totals after each address update, because the delivery address can affect shipping costs and the tax calculation.

## Choosing a shipping method

Shipping configuration has three parts: selecting a shipping method, optionally selecting a carrier or pickup location, and updating the cart.

### Fetch available shipping methods

#### Query

```graphql
query GetShippingMethods($cartId: String!) {
  cart(id: $cartId) {
    shippingMethods {
      name
      code
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cart": {
      "shippingMethods": [
        { "name": "Delivery", "code": "DELIVERY" },
        { "name": "Pickup", "code": "PICKUP" }
      ]
    }
  }
}
```

Present these options to the customer. If they choose delivery, fetch available carriers. If they choose pickup, fetch available pickup locations.

### Fetch available carriers

#### Query

```graphql
query GetCarriers($cartId: String!) {
  cart(id: $cartId) {
    carriers {
      id
      name
      price
      logo
      deliveryDeadline
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cart": {
      "carriers": [
        {
          "id": 1,
          "name": "PostNL",
          "price": 6.95,
          "logo": null,
          "deliveryDeadline": "2026-03-03T17:00:00Z"
        },
        {
          "id": 2,
          "name": "DHL",
          "price": 8.95,
          "logo": null,
          "deliveryDeadline": "2026-03-02T12:00:00Z"
        }
      ]
    }
  }
}
```

The `price` on a carrier is an estimate. The final shipping cost is calculated by Propeller's business rules when you set the carrier on the cart.

### Fetch pickup locations

If the customer chooses self-pickup, fetch active pickup locations using the `warehouses` query.

#### Query

```graphql
query GetPickupLocations {
  warehouses(input: { isActive: true, isPickupLocation: true }) {
    items {
      id
      name
      description
      address {
        street
        number
        city
        postalCode
        country
        phone
      }
      businessHours {
        dayOfWeek
        openingTime
        closingTime
      }
    }
    itemsFound
  }
}
```

#### Response

```json
{
  "data": {
    "warehouses": {
      "items": [
        {
          "id": 1,
          "name": "Magazijn Amsterdam",
          "description": "Afhaallocatie Amsterdam",
          "address": {
            "street": "Industrieweg",
            "number": "12",
            "city": "Amsterdam",
            "postalCode": "1099 DC",
            "country": "NL",
            "phone": "+31201234000"
          },
          "businessHours": [
            { "dayOfWeek": 1, "openingTime": "08:00", "closingTime": "17:00" },
            { "dayOfWeek": 2, "openingTime": "08:00", "closingTime": "17:00" },
            { "dayOfWeek": 3, "openingTime": "08:00", "closingTime": "17:00" },
            { "dayOfWeek": 4, "openingTime": "08:00", "closingTime": "17:00" },
            { "dayOfWeek": 5, "openingTime": "08:00", "closingTime": "15:00" }
          ]
        }
      ],
      "itemsFound": 1
    }
  }
}
```

### Set shipping method for delivery

After the customer selects a shipping method and carrier, update the cart using `cartUpdate` with `postageData`.

#### Mutation

```graphql
mutation SetShippingMethod($cartId: String!) {
  cartUpdate(
    id: $cartId
    input: {
      postageData: {
        method: "DELIVERY"
        carrier: "postnl"
        partialDeliveryAllowed: Y
      }
    }
  ) {
    postageData {
      method
      carrier
      price
      priceNet
      taxPercentage
      partialDeliveryAllowed
      requestDate
      priceMode
    }
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
      discount
      discountNet
    }
    taxLevels {
      taxPercentage
      price
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cartUpdate": {
      "postageData": {
        "method": "DELIVERY",
        "carrier": "postnl",
        "price": 6.95,
        "priceNet": 8.41,
        "taxPercentage": 21,
        "partialDeliveryAllowed": "Y",
        "requestDate": null,
        "priceMode": "PLATFORM"
      },
      "total": {
        "subTotal": 4785.12,
        "subTotalNet": 5789.99,
        "totalGross": 4792.07,
        "totalNet": 5798.40,
        "discount": 0,
        "discountNet": 0
      },
      "taxLevels": [
        { "taxPercentage": 21, "price": 1006.33 }
      ]
    }
  }
}
```

The `priceMode` field indicates whether the shipping cost was calculated by Propeller's business rules (`PLATFORM`) or set externally (`EXTERNAL`). To override shipping costs, pass a `price` in the `postageData` input, which sets `priceMode` to `EXTERNAL`.

The `partialDeliveryAllowed` flag lets the buyer indicate whether the supplier can ship available stock immediately and send remaining items in a follow-up shipment. B2B buyers often prefer partial deliveries because delaying the entire order until all items are available can halt production or operations.

### Set shipping method for self-pickup

#### Mutation

```graphql
mutation SetPickupMethod($cartId: String!) {
  cartUpdate(
    id: $cartId
    input: {
      postageData: {
        method: "PICKUP"
        pickUpLocationId: 1
      }
    }
  ) {
    postageData {
      method
      price
      priceNet
      pickUpLocationId
    }
    total {
      totalGross
      totalNet
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cartUpdate": {
      "postageData": {
        "method": "PICKUP",
        "price": 0,
        "priceNet": 0,
        "pickUpLocationId": 1
      },
      "total": {
        "totalGross": 4785.12,
        "totalNet": 5789.99
      }
    }
  }
}
```

The `pickUpLocationId` corresponds to a warehouse `id` from the `warehouses` query.

### Requesting a specific delivery date

You can pass a preferred delivery date using the `requestDate` field in `postageData`:

```graphql
postageData: {
  method: "DELIVERY"
  carrier: "postnl"
  requestDate: "2026-03-10T00:00:00Z"
}
```

This stores the customer's requested date on the cart. Whether this date is honored depends on carrier availability and Propeller's business rules.

## Choosing a payment method

### Fetch available payment methods

#### Query

```graphql
query GetPaymentMethods($cartId: String!) {
  cart(id: $cartId) {
    payMethods {
      code
      name
      type
      price
      taxCode
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cart": {
      "payMethods": [
        {
          "code": "ACCOUNT",
          "name": "Pay on account",
          "type": "ACCOUNT",
          "price": 0,
          "taxCode": "N"
        },
        {
          "code": "IDEAL",
          "name": "iDEAL",
          "type": "IDEAL",
          "price": 0.29,
          "taxCode": "H"
        },
        {
          "code": "CREDITCARD",
          "name": "Credit Card",
          "type": "CREDITCARD",
          "price": 0.50,
          "taxCode": "H"
        }
      ]
    }
  }
}
```

The `price` on a payment method is the transaction fee. The final fee is calculated by Propeller's business rules when you set the method on the cart.

### Set the payment method

#### Mutation

```graphql
mutation SetPaymentMethod($cartId: String!) {
  cartUpdate(
    id: $cartId
    input: {
      paymentData: {
        method: "IDEAL"
        status: "OPEN"
      }
    }
  ) {
    paymentData {
      method
      price
      priceNet
      taxPercentage
      status
      statusDate
      priceMode
    }
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
      discount
      discountNet
    }
    taxLevels {
      taxPercentage
      price
    }
  }
}
```

#### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

#### Response

```json
{
  "data": {
    "cartUpdate": {
      "paymentData": {
        "method": "IDEAL",
        "price": 0.29,
        "priceNet": 0.35,
        "taxPercentage": 21,
        "status": "OPEN",
        "statusDate": null,
        "priceMode": "PLATFORM"
      },
      "total": {
        "subTotal": 4785.12,
        "subTotalNet": 5789.99,
        "totalGross": 4792.36,
        "totalNet": 5798.75,
        "discount": 0,
        "discountNet": 0
      },
      "taxLevels": [
        { "taxPercentage": 21, "price": 1006.39 }
      ]
    }
  }
}
```

The default payment method is `ACCOUNT` (pay on account). If the customer selects a different method, the totals are recalculated to include the transaction fee. Like shipping costs, you can override the transaction fee by passing a `price` in the `paymentData` input.

Pay on account is the most common payment method in B2B commerce. Instead of paying at checkout, the company receives an invoice with payment terms (typically 30, 60 or 90 days). When the customer selects pay on account, no PSP redirect is needed after order creation. See [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration#pay-on-account-flow) for the simplified flow.

## Reviewing the cart

Before creating the order, fetch the complete cart for a final review. This gives the customer a chance to verify items, addresses, shipping, payment and totals.

### Query

```graphql
query ReviewCart($cartId: String!) {
  cart(id: $cartId) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    deliveryAddress {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      country
    }
    invoiceAddress {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      country
    }
    postageData {
      method
      carrier
      price
      priceNet
      taxPercentage
    }
    paymentData {
      method
      price
      priceNet
      taxPercentage
    }
    total {
      subTotal
      subTotalNet
      discount
      discountNet
      discountPercentage
      totalGross
      totalNet
    }
    taxLevels {
      taxPercentage
      price
    }
    actionCode
  }
}
```

### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

### Response

```json
{
  "data": {
    "cart": {
      "items": [
        {
          "itemId": "019c77b7-72a0-75fe-8a20-b98927d76652",
          "productId": 25,
          "quantity": 3,
          "price": 1595.04,
          "priceNet": 1929.9984,
          "totalPrice": 4785.12,
          "totalPriceNet": 5789.99
        }
      ],
      "deliveryAddress": {
        "firstName": "Sophie",
        "middleName": "van",
        "lastName": "Dijk",
        "company": "Brouwer Industrie",
        "street": "Keizersgracht",
        "number": "452",
        "numberExtension": null,
        "postalCode": "1016 GE",
        "city": "Amsterdam",
        "country": "NL"
      },
      "invoiceAddress": {
        "firstName": "Sophie",
        "middleName": "van",
        "lastName": "Dijk",
        "company": "Brouwer Industrie",
        "street": "Herengracht",
        "number": "100",
        "numberExtension": "A",
        "postalCode": "1015 BS",
        "city": "Amsterdam",
        "country": "NL"
      },
      "postageData": {
        "method": "DELIVERY",
        "carrier": "postnl",
        "price": 6.95,
        "priceNet": 8.41,
        "taxPercentage": 21
      },
      "paymentData": {
        "method": "IDEAL",
        "price": 0.29,
        "priceNet": 0.35,
        "taxPercentage": 21
      },
      "total": {
        "subTotal": 4785.12,
        "subTotalNet": 5789.99,
        "discount": 0,
        "discountNet": 0,
        "discountPercentage": 0,
        "totalGross": 4792.36,
        "totalNet": 5798.75
      },
      "taxLevels": [
        { "taxPercentage": 21, "price": 1006.39 }
      ],
      "actionCode": ""
    }
  }
}
```

Display this information clearly so the customer can verify everything before confirming. The pricing convention used throughout the cart: `price` fields are gross (excluding VAT) and `priceNet` fields are net (including VAT).

## Creating the order

Convert the cart to an order using `cartProcess`.

### Mutation

```graphql
mutation CreateOrder($cartId: String!) {
  cartProcess(
    id: $cartId
    input: { orderStatus: "UNFINISHED" }
  ) {
    cartOrderId
    order {
      id
      uuid
      status
      type
    }
  }
}
```

### Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

### Response

```json
{
  "data": {
    "cartProcess": {
      "cartOrderId": 534,
      "order": {
        "id": 534,
        "uuid": "019c8a12-3456-7890-abcd-ef1234567890",
        "status": "UNFINISHED",
        "type": "dropshipment"
      }
    }
  }
}
```

The `cartOrderId` is the Propeller order ID. You need this for payment tracking and order confirmation. The `order` field returns the full created order object if you need additional fields.

### Choosing an order status

| Status | When to use |
|---|---|
| `UNFINISHED` | Customer needs to complete online payment (iDEAL, credit card, etc.). Create the order first, then redirect to the PSP |
| `NEW` | No online payment required (e.g. pay on account). The order goes directly to a confirmed state |

For orders requiring online payment, always use `UNFINISHED` first. After payment succeeds, update the status with `orderSetStatus`. See [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration) for the full payment flow.

### Order confirmation language

The `language` field on `CartProcessInput` controls which language the order confirmation email is sent in:

```graphql
cartProcess(
  id: $cartId
  input: { orderStatus: "UNFINISHED", language: "NL" }
)
```

If not provided, the default language is used.

## Purchase authorization

Purchase authorization is a standard procurement control in B2B. Companies configure spending limits per contact to prevent unauthorized purchases. When a contact places an order that exceeds their limit, the cart enters a pending state until an authorization manager (typically a procurement lead or department head) approves or rejects it. Your frontend should show a clear message explaining that the order is awaiting approval.

The cart has a `purchaseAuthorizationRequired` field. When this is `true`, the contact's spending limit has been exceeded and the order requires approval before it can be processed.

Check this field before calling `cartProcess`:

```graphql
query CheckAuthorization($cartId: String!) {
  cart(id: $cartId) {
    purchaseAuthorizationRequired
    status
  }
}
```

Expected response:

```json
{
  "data": {
    "cart": {
      "purchaseAuthorizationRequired": false,
      "status": "OPEN"
    }
  }
}
```

If `purchaseAuthorizationRequired` is `true`, call `cartRequestPurchaseAuthorization` instead of `cartProcess`. The cart status changes to `PENDING_PURCHASE_AUTHORIZATION` until an authorization manager approves it with `cartAcceptPurchaseAuthorizationRequest`.

For more on how purchase authorization roles and limits work, see [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers).

## Typical checkout sequence

Here is the full sequence of API calls for a standard checkout:

1. **`viewer` query** — fetch stored addresses for logged-in users (skip for guests)
2. **`cartUpdateAddress` (DELIVERY)** — set the delivery address
3. **`cartUpdateAddress` (INVOICE)** — set the invoice address
4. **`cart` query** — fetch available shipping methods and carriers
5. **`cartUpdate` (postageData)** — set the shipping method and carrier
6. **`cart` query** — fetch available payment methods
7. **`cartUpdate` (paymentData)** — set the payment method
8. **`cart` query** — fetch the complete cart for final review
9. **`cartProcess`** — create the order
10. **Redirect to PSP** → handle payment → update order status (see [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration))

Steps 4 and 6 can be combined into a single query if you fetch `shippingMethods`, `carriers` and `payMethods` at the same time. Similarly, step 8 can be combined with step 7 by requesting all review fields in the `cartUpdate` response.

## Next steps

- [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration) — track payments, handle PSP callbacks and confirm orders
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — create and manage cart items before checkout
- [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) — how orders, quotes and quote requests relate

---

## Payment Integration

URL: https://docs.propeller-commerce.com/frontend/domain-guides/cart-and-checkout/payment-integration

# Payment integration

Propeller does not process payments. It stores payment records and transaction history while actual payment processing is handled by an external payment service provider (PSP) such as Mollie, Adyen or MultiSafepay. This page covers creating, updating and querying payment records in Propeller and confirming or failing orders based on the PSP result.

For the steps leading up to order creation (addresses, shipping, payment method selection and `cartProcess`), see [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow). For order lifecycle concepts and status transitions, see [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle).

## How payments work in Propeller

When a customer checks out with an online payment method, the order is created with status `UNFINISHED` (meaning it awaits payment). Your application then redirects the customer to the PSP. After the PSP processes the payment, it sends a callback to your backend. Your backend records the result in Propeller and confirms or fails the order.

The typical flow:

1. `cartProcess` creates the order with status `UNFINISHED`
2. Your application redirects the customer to the PSP
3. The PSP processes the payment
4. The PSP sends a callback to your backend
5. `paymentCreate` records the payment in Propeller
6. `paymentUpdate` updates the payment when the PSP confirms the final result
7. `orderSetStatus` confirms the order (or marks it as failed)

Each payment record in Propeller can contain multiple transactions. Transactions form an audit trail of every step in the payment lifecycle. For example, an authorization followed by a capture followed by a partial refund would produce three transaction records on the same payment.

## Payment statuses and transaction types

### Payment statuses

The `PaymentStatuses` enum tracks the overall state of a payment record.

| Status | Description |
|---|---|
| `OPEN` | Payment created, awaiting processing |
| `PENDING` | Payment is being processed by the PSP |
| `AUTHORIZED` | Payment authorized but not yet captured |
| `CANCELLED` | Payment cancelled by the customer or merchant |
| `EXPIRED` | Payment expired before completion |
| `FAILED` | Payment attempt failed |
| `PAID` | Payment successfully completed |
| `REFUNDED` | Payment has been refunded |
| `CHARGEBACK` | Payment reversed by the bank (chargeback) |

### Transaction types

The `TransactionTypes` enum categorizes individual transactions within a payment.

| Type | Description |
|---|---|
| `AUTHORIZATION` | Funds reserved on the customer's account |
| `CANCEL_AUTHORIZATION` | Previously authorized funds released |
| `PAY` | Funds captured or paid |
| `REFUND` | Funds returned to the customer |
| `CHARGEBACK` | Funds reversed by the bank |

### Transaction statuses

The `TransactionStatuses` enum tracks the outcome of an individual transaction.

| Status | Description |
|---|---|
| `OPEN` | Transaction initiated, awaiting result |
| `PENDING` | Transaction is being processed |
| `FAILED` | Transaction failed |
| `SUCCESS` | Transaction completed successfully |

## Creating a payment record

After initiating the payment with the PSP, create a payment record in Propeller using `paymentCreate`. This records the initial payment state and optionally includes the first transaction.

> **Amounts are in cents.** The `amount` field is an integer representing the amount in the smallest currency unit. For example, €128.50 is `12850`.

### Mutation

```graphql
mutation PaymentCreate($input: CreatePaymentInput!) {
  paymentCreate(input: $input) {
    id
    orderId
    amount
    currency
    method
    status
    paymentId
    transactions {
      id
      transactionId
      amount
      currency
      type
      status
      provider
      timestamp
    }
    createdAt
  }
}
```

### Variables

```json
{
  "input": {
    "orderId": 534,
    "amount": 12850,
    "currency": "EUR",
    "method": "ideal",
    "status": "OPEN",
    "paymentId": "pay_9B7dCf3Hxk",
    "addTransaction": {
      "transactionId": "tr_WdjK5Nf4p2",
      "paymentId": "pay_9B7dCf3Hxk",
      "amount": 12850,
      "currency": "EUR",
      "type": "PAY",
      "status": "OPEN",
      "provider": "Mollie",
      "timestamp": "2025-11-03T14:22:08Z"
    }
  }
}
```

### Response

```json
{
  "data": {
    "paymentCreate": {
      "id": "87",
      "orderId": 534,
      "amount": 12850,
      "currency": "EUR",
      "method": "ideal",
      "status": "OPEN",
      "paymentId": "pay_9B7dCf3Hxk",
      "transactions": [
        {
          "id": "201",
          "transactionId": "tr_WdjK5Nf4p2",
          "amount": 12850,
          "currency": "EUR",
          "type": "PAY",
          "status": "OPEN",
          "provider": "Mollie",
          "timestamp": "2025-11-03T14:22:08Z"
        }
      ],
      "createdAt": "2025-11-03T14:22:09Z"
    }
  }
}
```

### CreatePaymentInput fields

| Field | Type | Required | Description |
|---|---|---|---|
| `orderId` | `Int!` | Yes | The order ID returned by `cartProcess` (`cartOrderId`) |
| `amount` | `Int!` | Yes | Payment amount in cents |
| `currency` | `String!` | Yes | ISO 4217 currency code (e.g. `EUR`, `USD`) |
| `method` | `String!` | Yes | PSP payment method identifier (e.g. `ideal`, `creditcard`) |
| `status` | `PaymentStatuses!` | Yes | Initial payment status (typically `OPEN`) |
| `paymentId` | `String` | No | PSP payment identifier to store for later reference |
| `userId` | `Int` | No | Logged-in user ID |
| `anonymousId` | `Int` | No | Guest user ID |
| `addTransaction` | `CreateTransactionInput` | No | Initial transaction to record |

### CreateTransactionInput fields

| Field | Type | Required | Description |
|---|---|---|---|
| `transactionId` | `String!` | Yes | PSP transaction identifier |
| `amount` | `Int!` | Yes | Transaction amount in cents |
| `currency` | `String!` | Yes | ISO 4217 currency code |
| `type` | `TransactionTypes!` | Yes | Transaction type (`PAY`, `AUTHORIZATION`, `REFUND`, `CANCEL_AUTHORIZATION`, `CHARGEBACK`) |
| `status` | `TransactionStatuses!` | Yes | Transaction status (`OPEN`, `PENDING`, `FAILED`, `SUCCESS`) |
| `paymentId` | `String` | No | PSP payment identifier |
| `description` | `String` | No | Description of the transaction |
| `timestamp` | `DateTime` | No | When the transaction occurred at the PSP |
| `provider` | `String` | No | PSP provider name (e.g. `Mollie`, `Adyen`) |

## Updating a payment

When the PSP sends a callback confirming the payment result, update the payment record using `paymentUpdate`. The `searchBy` argument identifies which payment to update, and `addTransaction` appends a new transaction entry to the payment's history.

### Mutation

```graphql
mutation PaymentUpdate($searchBy: SearchByInput!, $input: UpdatePaymentInput!) {
  paymentUpdate(searchBy: $searchBy, input: $input) {
    id
    orderId
    amount
    currency
    method
    status
    paymentId
    transactions {
      id
      transactionId
      amount
      currency
      type
      status
      provider
      timestamp
    }
    lastModifiedAt
  }
}
```

### Variables

```json
{
  "searchBy": {
    "orderId": 534
  },
  "input": {
    "status": "PAID",
    "addTransaction": {
      "transactionId": "tr_WdjK5Nf4p2",
      "paymentId": "pay_9B7dCf3Hxk",
      "amount": 12850,
      "currency": "EUR",
      "type": "PAY",
      "status": "SUCCESS",
      "provider": "Mollie",
      "timestamp": "2025-11-03T14:23:41Z"
    }
  }
}
```

### Response

```json
{
  "data": {
    "paymentUpdate": {
      "id": "87",
      "orderId": 534,
      "amount": 12850,
      "currency": "EUR",
      "method": "ideal",
      "status": "PAID",
      "paymentId": "pay_9B7dCf3Hxk",
      "transactions": [
        {
          "id": "201",
          "transactionId": "tr_WdjK5Nf4p2",
          "amount": 12850,
          "currency": "EUR",
          "type": "PAY",
          "status": "OPEN",
          "provider": "Mollie",
          "timestamp": "2025-11-03T14:22:08Z"
        },
        {
          "id": "202",
          "transactionId": "tr_WdjK5Nf4p2",
          "amount": 12850,
          "currency": "EUR",
          "type": "PAY",
          "status": "SUCCESS",
          "provider": "Mollie",
          "timestamp": "2025-11-03T14:23:41Z"
        }
      ],
      "lastModifiedAt": "2025-11-03T14:23:42Z"
    }
  }
}
```

Notice that the response now contains two transactions. Each `addTransaction` appends a new entry. This gives you a complete audit trail of the payment lifecycle.

### SearchByInput fields

The `searchBy` argument lets you identify the payment by different identifiers. Provide exactly one.

| Field | Type | Description |
|---|---|---|
| `id` | `ID` | Propeller's internal payment identifier |
| `paymentId` | `String` | PSP payment identifier (as stored via `paymentId` on create) |
| `orderId` | `Float` | The order ID the payment belongs to |

> The `orderId` field in `SearchByInput` is typed as `Float` in the schema. Pass the order ID as a number (e.g. `534`).

### UpdatePaymentInput fields

All fields are optional. Only the fields you provide will be updated.

| Field | Type | Description |
|---|---|---|
| `status` | `PaymentStatuses` | Updated payment status |
| `amount` | `Int` | Updated amount in cents |
| `currency` | `String` | Updated currency code |
| `method` | `String` | Updated payment method |
| `paymentId` | `String` | Updated PSP payment identifier |
| `userId` | `Int` | Updated user ID |
| `anonymousId` | `Int` | Updated guest user ID |
| `addTransaction` | `CreateTransactionInput` | New transaction to append |

## Confirming the order

After a successful payment, transition the order from `UNFINISHED` to `NEW` (or another confirmed status) using `orderSetStatus`. This also sets the payment status on the order and can trigger a confirmation email.

### Mutation

```graphql
mutation OrderSetStatus($input: OrderSetStatusInput!) {
  orderSetStatus(input: $input) {
    id
    status
    paymentData {
      status
      statusDate
    }
  }
}
```

### Variables

```json
{
  "input": {
    "orderId": 534,
    "status": "NEW",
    "payStatus": "PAID",
    "sendOrderConfirmationEmail": true,
    "addPDFAttachment": true,
    "deleteCart": true
  }
}
```

### Response

```json
{
  "data": {
    "orderSetStatus": {
      "id": 534,
      "status": "NEW",
      "paymentData": {
        "status": "PAID",
        "statusDate": "2025-11-03T14:23:45Z"
      }
    }
  }
}
```

### OrderSetStatusInput fields

| Field | Type | Required | Description |
|---|---|---|---|
| `orderId` | `Int!` | Yes | The order to update |
| `status` | `String` | No | New order status code (e.g. `NEW`) |
| `payStatus` | `String` | No | Payment status to set on the order (e.g. `PAID`, `OPEN`, `FAILED`) |
| `sendOrderConfirmationEmail` | `Boolean` | No | Send a confirmation email to the customer (default: `false`) |
| `addPDFAttachment` | `Boolean` | No | Attach a PDF invoice to the confirmation email (default: `false`) |
| `triggerOrderSendConfirmEvent` | `Boolean` | No | Trigger an `ORDER_SEND_CONFIRMATION` event via the Event Action Manager (default: `false`) |
| `deleteCart` | `Boolean` | No | Delete the originating cart after confirmation (default: `false`) |

> The `status` transition must be allowed by the configured status workflow. If you attempt a transition that is not configured, the API returns an `ORDER_STATUS_TRANSITION_NOT_ALLOWED` error. See [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) for details on status transitions.

## Handling failed payments

When the PSP reports that a payment failed (customer cancelled, card declined, timeout), update the payment record and the order status to reflect the failure.

### Update the payment

```graphql
mutation PaymentUpdate($searchBy: SearchByInput!, $input: UpdatePaymentInput!) {
  paymentUpdate(searchBy: $searchBy, input: $input) {
    id
    orderId
    status
    transactions {
      id
      transactionId
      type
      status
      timestamp
    }
  }
}
```

```json
{
  "searchBy": {
    "orderId": 534
  },
  "input": {
    "status": "CANCELLED",
    "addTransaction": {
      "transactionId": "tr_WdjK5Nf4p2",
      "paymentId": "pay_9B7dCf3Hxk",
      "amount": 12850,
      "currency": "EUR",
      "type": "PAY",
      "status": "FAILED",
      "provider": "Mollie",
      "timestamp": "2025-11-03T14:25:12Z",
      "description": "Payment cancelled by customer"
    }
  }
}
```

Expected response:

```json
{
  "data": {
    "paymentUpdate": {
      "id": "8",
      "orderId": 534,
      "status": "CANCELLED",
      "transactions": [
        {
          "id": "12",
          "transactionId": "tr_QrPm8Xk3v1",
          "type": "PAY",
          "status": "OPEN",
          "timestamp": "2025-11-03T14:20:00.000Z"
        },
        {
          "id": "13",
          "transactionId": "tr_WdjK5Nf4p2",
          "type": "PAY",
          "status": "FAILED",
          "timestamp": "2025-11-03T14:25:12.000Z"
        }
      ]
    }
  }
}
```

Use the payment status that best matches the PSP result. For example, use `CANCELLED` when the customer cancelled, `EXPIRED` when the payment window timed out and `FAILED` for a declined card.

### Update the order status

```graphql
mutation OrderSetStatus($input: OrderSetStatusInput!) {
  orderSetStatus(input: $input) {
    id
    status
    paymentData {
      status
    }
  }
}
```

```json
{
  "input": {
    "orderId": 534,
    "status": "NEW",
    "payStatus": "FAILED"
  }
}
```

Expected response:

```json
{
  "data": {
    "orderSetStatus": {
      "id": 534,
      "status": "NEW",
      "paymentData": {
        "status": "FAILED"
      }
    }
  }
}
```

### Retrying a payment

To let the customer retry payment after a failure, create a new payment record for the same order using `paymentCreate`. The previous payment and its transactions remain in the history as an audit trail. Redirect the customer to the PSP again and follow the same flow.

## Refunds

To record a refund, update the payment with a `REFUND` transaction and set the payment status to `REFUNDED`.

### Mutation

```graphql
mutation PaymentUpdate($searchBy: SearchByInput!, $input: UpdatePaymentInput!) {
  paymentUpdate(searchBy: $searchBy, input: $input) {
    id
    orderId
    status
    transactions {
      id
      transactionId
      amount
      type
      status
      timestamp
    }
  }
}
```

### Variables

```json
{
  "searchBy": {
    "orderId": 534
  },
  "input": {
    "status": "REFUNDED",
    "addTransaction": {
      "transactionId": "tr_Rf8mN2Kp7v",
      "paymentId": "pay_9B7dCf3Hxk",
      "amount": 12850,
      "currency": "EUR",
      "type": "REFUND",
      "status": "SUCCESS",
      "provider": "Mollie",
      "timestamp": "2025-11-05T09:15:30Z",
      "description": "Full refund for order 534"
    }
  }
}
```

### Response

```json
{
  "data": {
    "paymentUpdate": {
      "id": "87",
      "orderId": 534,
      "status": "REFUNDED",
      "transactions": [
        {
          "id": "201",
          "transactionId": "tr_WdjK5Nf4p2",
          "amount": 12850,
          "type": "PAY",
          "status": "OPEN",
          "timestamp": "2025-11-03T14:22:08Z"
        },
        {
          "id": "202",
          "transactionId": "tr_WdjK5Nf4p2",
          "amount": 12850,
          "type": "PAY",
          "status": "SUCCESS",
          "timestamp": "2025-11-03T14:23:41Z"
        },
        {
          "id": "203",
          "transactionId": "tr_Rf8mN2Kp7v",
          "amount": 12850,
          "type": "REFUND",
          "status": "SUCCESS",
          "timestamp": "2025-11-05T09:15:30Z"
        }
      ]
    }
  }
}
```

For partial refunds, set the transaction `amount` to the refunded amount in cents rather than the full payment amount.

## Pay-on-account flow

For B2B customers who pay on account, no PSP integration is needed. The order is created with a confirmed status directly and no payment records are required.

Use `cartProcess` with status `NEW` instead of `UNFINISHED`:

```graphql
mutation CartProcess($id: String!, $input: CartProcessInput!) {
  cartProcess(id: $id, input: $input) {
    cart {
      cartId
    }
    order {
      id
      status
    }
    cartOrderId
  }
}
```

```json
{
  "id": "018dcc9a-f965-7434-8fad-369aa9a8c276",
  "input": {
    "orderStatus": "NEW"
  }
}
```

Expected response:

```json
{
  "data": {
    "cartProcess": {
      "cart": {
        "cartId": "018dcc9a-f965-7434-8fad-369aa9a8c276"
      },
      "order": {
        "id": 534,
        "status": "NEW"
      },
      "cartOrderId": 534
    }
  }
}
```

Then confirm the order and trigger the confirmation email:

```graphql
mutation OrderSetStatus($input: OrderSetStatusInput!) {
  orderSetStatus(input: $input) {
    id
    status
    paymentData {
      status
    }
  }
}
```

```json
{
  "input": {
    "orderId": 534,
    "status": "NEW",
    "payStatus": "OPEN",
    "sendOrderConfirmationEmail": true,
    "addPDFAttachment": true,
    "deleteCart": true
  }
}
```

Expected response:

```json
{
  "data": {
    "orderSetStatus": {
      "id": 534,
      "status": "NEW",
      "paymentData": {
        "status": "OPEN"
      }
    }
  }
}
```

No `paymentCreate` or `paymentUpdate` calls are needed. The order is confirmed with payment status `OPEN`, indicating that payment will be handled outside the checkout flow (e.g. via invoice).

## Fetching payment records

### Fetch a single payment

Use the `payment` query to retrieve a specific payment record. The `searchBy` argument accepts the same fields as `paymentUpdate` (Propeller `id`, PSP `paymentId` or `orderId`).

#### Query

```graphql
query Payment($searchBy: SearchByInput!) {
  payment(searchBy: $searchBy) {
    id
    orderId
    amount
    currency
    method
    status
    paymentId
    userId
    anonymousId
    transactions {
      id
      transactionId
      orderId
      amount
      currency
      type
      status
      paymentId
      description
      provider
      timestamp
    }
    createdAt
    createdBy
    lastModifiedAt
    lastModifiedBy
  }
}
```

#### Variables

```json
{
  "searchBy": {
    "orderId": 534
  }
}
```

#### Response

```json
{
  "data": {
    "payment": {
      "id": "87",
      "orderId": 534,
      "amount": 12850,
      "currency": "EUR",
      "method": "ideal",
      "status": "PAID",
      "paymentId": "pay_9B7dCf3Hxk",
      "userId": null,
      "anonymousId": null,
      "transactions": [
        {
          "id": "201",
          "transactionId": "tr_WdjK5Nf4p2",
          "orderId": 534,
          "amount": 12850,
          "currency": "EUR",
          "type": "PAY",
          "status": "OPEN",
          "paymentId": "pay_9B7dCf3Hxk",
          "description": null,
          "provider": "Mollie",
          "timestamp": "2025-11-03T14:22:08Z"
        },
        {
          "id": "202",
          "transactionId": "tr_WdjK5Nf4p2",
          "orderId": 534,
          "amount": 12850,
          "currency": "EUR",
          "type": "PAY",
          "status": "SUCCESS",
          "paymentId": "pay_9B7dCf3Hxk",
          "description": null,
          "provider": "Mollie",
          "timestamp": "2025-11-03T14:23:41Z"
        }
      ],
      "createdAt": "2025-11-03T14:22:09Z",
      "createdBy": "system",
      "lastModifiedAt": "2025-11-03T14:23:42Z",
      "lastModifiedBy": "system"
    }
  }
}
```

The `payment` query returns `null` when no payment is found for the given search criteria.

### List payments

Use the `payments` query to list payment records with pagination.

#### Query

```graphql
query Payments($input: PaymentsSearchInput) {
  payments(input: $input) {
    items {
      id
      orderId
      amount
      currency
      method
      status
      paymentId
      createdAt
    }
    itemsFound
    page
    pages
    offset
    start
    end
  }
}
```

#### Variables

```json
{
  "input": {
    "page": 1,
    "offset": 12
  }
}
```

#### Response

```json
{
  "data": {
    "payments": {
      "items": [
        {
          "id": "87",
          "orderId": 534,
          "amount": 12850,
          "currency": "EUR",
          "method": "ideal",
          "status": "PAID",
          "paymentId": "pay_9B7dCf3Hxk",
          "createdAt": "2025-11-03T14:22:09Z"
        },
        {
          "id": "86",
          "orderId": 521,
          "amount": 4500,
          "currency": "EUR",
          "method": "banktransfer",
          "status": "PAID",
          "paymentId": "pay_3Hk7mWn9Rp",
          "createdAt": "2025-10-28T10:05:22Z"
        }
      ],
      "itemsFound": 2,
      "page": 1,
      "pages": 1,
      "offset": 12,
      "start": 0,
      "end": 2
    }
  }
}
```

## Deleting a payment record

Use `paymentDelete` to remove a payment record. The `searchBy` argument works the same way as in `paymentUpdate`.

### Mutation

```graphql
mutation PaymentDelete($searchBy: SearchByInput!) {
  paymentDelete(searchBy: $searchBy) {
    id
    orderId
    status
  }
}
```

### Variables

```json
{
  "searchBy": {
    "id": "87"
  }
}
```

### Response

```json
{
  "data": {
    "paymentDelete": {
      "id": "87",
      "orderId": 534,
      "status": "PAID"
    }
  }
}
```

The mutation returns the deleted payment record.

## Payment flow summary

### Online payment (iDEAL, credit card, etc.)

```
cartProcess (UNFINISHED)
  → redirect to PSP
  → paymentCreate (OPEN)
  → PSP callback (success)
  → paymentUpdate (PAID)
  → orderSetStatus (NEW / PAID)
```

### Pay on account

```
cartProcess (NEW)
  → orderSetStatus (NEW / OPEN)
```

### Failed payment

```
cartProcess (UNFINISHED)
  → redirect to PSP
  → paymentCreate (OPEN)
  → PSP callback (failed)
  → paymentUpdate (CANCELLED or FAILED)
  → orderSetStatus (UNSUCCESSFUL / FAILED)
  → optionally retry with a new paymentCreate
```

## Next steps

- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) for setting addresses, shipping and payment on the cart before order creation
- [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) for order statuses, transitions and the quote-to-order lifecycle
- [Order history](/frontend/domain-guides/orders-and-shipments/order-history) for displaying order history to customers

---

## Understanding the Order Lifecycle

URL: https://docs.propeller-commerce.com/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle

# Understanding the order lifecycle

In Propeller, orders, quotes and quote requests are all the same object: an **Order**. What distinguishes them is the combination of `type` and `status` on the order. This unified model means you query, display and manage all three using the same API. Understanding how the order lifecycle works helps you build checkout flows, quote request forms, order history pages and status displays correctly.

## The unified order model

Every order in Propeller has two fields that define what it represents:

- **`type`** (OrderType) categorizes the order by its business purpose.
- **`status`** (a string matching a configured OrderStatus code) determines where the order sits in its lifecycle.

### OrderType

The `type` field is an enum with four values:

| Type | Purpose |
|---|---|
| `dropshipment` | A standard order fulfilled by shipping to the customer |
| `quotation` | A quote or quote request |
| `purchase` | A purchase order (procurement) |
| `stock` | A stock order (internal inventory) |

For most frontend applications, you work with `dropshipment` (orders) and `quotation` (quotes and quote requests).

### OrderStatus

Each order status is a configured object with its own fields:

| Field | Description |
|---|---|
| `code` | The status identifier (e.g. `NEW`, `QUOTATION`, `SHIPPED`) |
| `name` | Human-readable label |
| `orderType` | Categorizes the status as `ORDER`, `QUOTATION` or `REQUEST` |
| `type` | Whether the status is `SYSTEM` (built-in) or `CUSTOM` (user-defined) |
| `isPublic` | Whether the status is visible to customers |
| `isDefault` | Whether this is the default status for its order type |
| `nextStatuses` | Which statuses this status can transition to |
| `previousStatuses` | Which statuses can transition to this status |
| `statusSet` | The parent group this status belongs to |

The `orderType` field on a status is what ultimately tells you whether an order is a quote request (`REQUEST`), a quote (`QUOTATION`) or an order (`ORDER`).

### How type and status combine

| What it represents | OrderType | OrderStatus orderType | Status examples |
|---|---|---|---|
| Quote request | `quotation` | `REQUEST` | `QUOTE_REQUEST` |
| Draft quote | `quotation` | `QUOTATION` | `DRAFT_QUOTATION` |
| Published quote | `quotation` | `QUOTATION` | `QUOTATION` |
| Order | `dropshipment` | `ORDER` | `NEW`, `PROCESSING`, `SHIPPED` |

Because quotes and orders share the same data model, you query them using the same `orders` query and filter by `type` or `status` to display the right records in the right context.

## How orders are created

There are three paths to creating an order. Each produces the same Order object but serves a different use case.

### Cart (storefront checkout)

The most common path for customer-facing applications. A customer builds a cart, sets addresses, selects shipping and payment, then converts the cart into an order using `cartProcess`.

```
cartStart → add items → set addresses → choose shipping → choose payment → cartProcess
```

The `cartProcess` mutation takes an `orderStatus` (typically `UNFINISHED` for orders requiring payment or `NEW` for orders on account) and returns the created order with its `cartOrderId`.

This is the path covered in [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) and [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow).

### Tender (sales portal)

A tender is an extended cart used by sales representatives. It allows adjusting item prices, applying discounts, viewing margins and managing customer-specific pricing. Tenders are typically used in a sales portal, not in a frontend customer portal.

```
tenderStart → add items → adjust pricing and discounts → tenderProcess
```

Key differences from a cart:

| Aspect | Cart | Tender |
|---|---|---|
| User | Customer | Sales representative |
| Pricing | Fixed (based on price sheets and rules) | Adjustable per item |
| Discounts | Applied via action codes | Manually set with margin visibility |
| Owner | The customer placing the order | The sales rep (`ownerId`), separate from the customer |
| Output | `cartProcess` → order | `tenderProcess` → order |

When a tender is processed, it creates the same Order object as a cart would. The `source` field on the resulting order indicates where it originated (e.g. "Sales Portal").

### Direct creation (API and admin)

For integrations and backend systems, orders can be created directly using the `orderCreate` mutation. This creates a complete order in a single call without going through the cart or tender flow.

### All paths converge

Regardless of how an order is created, the result is the same Order object. The `cartId` field on an order indicates whether it originated from a cart. The `source` field records where the order came from.

```
Cart (storefront)     ──→
Tender (sales portal) ──→  Order
orderCreate (API)     ──→
```

## Order statuses and transitions

Order statuses in Propeller are not just labels. They form a directed graph of allowed transitions. Each status defines which other statuses it can move to (`nextStatuses`) and which statuses can move to it (`previousStatuses`).

### Status sets

Statuses are organized into sets (OrderStatusSet). A set is a named group of related statuses. This is useful for workflow organization, for example grouping all quote-related statuses into one set and all fulfillment statuses into another.

### Common statuses

These are common system statuses found in a typical Propeller environment. Statuses are fully configurable, so your environment may have different codes and transitions.

| Status code | Order type | Description |
|---|---|---|
| `QUOTE_REQUEST` | `REQUEST` | Customer submitted a quote request |
| `DRAFT_QUOTATION` | `QUOTATION` | Sales rep is drafting a quote (not visible to customer) |
| `QUOTATION` | `QUOTATION` | Published quote, visible to customer |
| `UNFINISHED` | `ORDER` | Order created, awaiting payment |
| `NEW` | `ORDER` | Confirmed order |
| `PROCESSING` | `ORDER` | Order is being processed |
| `SHIPPED` | `ORDER` | Order has been shipped |
| `COMPLETED` | `ORDER` | Order delivered and completed |

### Enforced transitions

The `orderSetStatus` mutation enforces valid transitions. If you attempt a transition that is not allowed by the status configuration, the API returns an `ORDER_STATUS_TRANSITION_NOT_ALLOWED` error.

The `orderSetStatus` input accepts:

| Field | Description |
|---|---|
| `orderId` | The order to update |
| `status` | The new status code |
| `payStatus` | Optional payment status update |
| `sendOrderConfirmationEmail` | Whether to send a confirmation email |
| `addPDFAttachment` | Whether to attach a PDF to the email |
| `deleteCart` | Whether to delete the originating cart |

### Public vs. internal statuses

The `isPublic` flag on a status controls whether it is visible to customers. Internal statuses (where `isPublic` is false) are only visible to admin users and sales representatives. Use this flag to decide which statuses to display in a customer-facing order history page.

## Example lifecycle: quote to order

This example walks through a complete lifecycle from quote request to fulfilled order, showing how the same Order object moves through different statuses.

**1. Customer submits a quote request**

A customer builds a cart and processes it with a quote request status. The resulting order has type `quotation` and status `QUOTE_REQUEST`.

**2. Sales rep creates a draft quote**

A sales representative opens the order in the sales portal and adjusts pricing and discounts. The status moves to `DRAFT_QUOTATION`. This status is not public, so the customer cannot see the draft.

**3. Sales rep publishes the quote**

When the quote is ready, the sales rep transitions the status to `QUOTATION`. This status is public, so the customer can now view the quote and its pricing. The quote may have a `validUntil` date after which it expires.

**4. Sales rep revises the quote**

If changes are needed, the sales rep transitions back to `DRAFT_QUOTATION`, makes adjustments and publishes again. Each change is tracked in the version history (see below).

**5. Customer accepts the quote**

The customer accepts the quote, which transitions the status from `QUOTATION` to an order status like `NEW`. At this point the order type remains `quotation` but the status order type changes from `QUOTATION` to `ORDER`.

**6. Order moves through fulfillment**

The order progresses through fulfillment statuses: `PROCESSING` → `SHIPPED` → `COMPLETED`. Shipments are created and tracked along the way.

```
QUOTE_REQUEST → DRAFT_QUOTATION → QUOTATION → DRAFT_QUOTATION → QUOTATION → NEW → PROCESSING → SHIPPED → COMPLETED
     (1)              (2)             (3)            (4)             (4)       (5)      (6)         (6)        (6)
```

## Version history

Orders track every change as a revision. Each revision stores a sequential number, a timestamp, who made the change and a snapshot of the order state at that point.

### Revision fields

| Field | Description |
|---|---|
| `revisionNumber` | Sequential number, starting at 1 |
| `createdAt` | When the revision was created |
| `createdByAdminUser` | The admin user who made the change (if applicable) |
| `createdByContact` | The contact who made the change (if applicable) |
| `createdByCustomer` | The customer who made the change (if applicable) |
| `createdFromRevisionNumber` | The revision this one was branched from |

### Snapshots

Each revision contains a snapshot of the order state, including the status, type and visibility flags. Two fields are particularly relevant for frontends:

- **`public`**: whether this revision is visible to customers.
- **`publicVersionNumber`**: the version number that customers see.

Public revisions get an incrementing `publicVersionNumber`. Private revisions (like draft edits) do not increment this number and are not visible to customers.

### Example revision trail

For the quote-to-order lifecycle described above, the revision history might look like this:

| Revision | Status | Public | Customer sees |
|---|---|---|---|
| 1 | `DRAFT_QUOTATION` | No | Nothing |
| 2 | `QUOTATION` | Yes | Version 1 |
| 3 | `DRAFT_QUOTATION` | No | Still version 1 |
| 4 | `QUOTATION` | Yes | Version 2 |
| 5 | `NEW` | Yes | Version 3 (order confirmed) |

### Revision mutations

Two mutations manage revisions:

- **`orderRevisionRestore`** restores an order to a previous revision state. Takes `orderId` and `revisionNumber`.
- **`orderRevisionsInvalidate`** marks specific revisions as invalid.

## Shipment tracking

After an order is confirmed, shipments track the physical fulfillment. Each shipment has a status that progresses through delivery stages:

| Status | Description |
|---|---|
| `CREATED` | Shipment record created |
| `PROCESSING` | Being prepared |
| `IN_TRANSIT` | Picked up by carrier |
| `OUT_FOR_DELIVERY` | Out for final delivery |
| `DELIVERED` | Successfully delivered |
| `PARTIALLY_DELIVERED` | Some items delivered |
| `FAILED_DELIVERY` | Delivery attempt failed |
| `CANCELED` | Shipment canceled |
| `EXCEPTION` | An exception occurred |

An order can have multiple shipments for partial deliveries. Each shipment can carry track-and-trace codes for carrier tracking.

## Key fields on the Order object

These are the fields most relevant to understanding the order lifecycle. For complete field documentation, see the [GraphQL API reference](/reference/graphql).

| Field | Description |
|---|---|
| `id` | Auto-increment order ID |
| `uuid` | UUID identifier |
| `status` | Current status code |
| `type` | Order type (`dropshipment`, `quotation`, `purchase`, `stock`) |
| `source` | Where the order was created (e.g. webshop name, "Sales Portal") |
| `cartId` | The originating cart ID, if created via `cartProcess` |
| `originalOrderId` | Reference to the original order (for copies) |
| `validUntil` | Expiry date (used for quotes) |
| `createdAt` | Creation timestamp |
| `lastModifiedAt` | Last modification timestamp |
| `statusDate` | When the status was last changed |
| `companyId` | The company this order belongs to |
| `invoiceUserId` | The user responsible for payment |
| `items` | The order line items |
| `total` | Order totals (subtotal, tax, shipping, grand total) |
| `orderAddresses` | Billing and shipping addresses |
| `shipments` | Associated shipments |

## What this means for your frontend

Understanding the order lifecycle helps you build the right features for each stage:

1. **Cart management** creates and manages the mutable cart before checkout. See [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management).
2. **Checkout flow** sets addresses, shipping and payment on the cart and converts it to an order with `cartProcess`. See [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow).
3. **Quote requests** use `cartProcess` with a quote request status to submit the cart as a request for quotation.
4. **Order history** queries orders and filters by type or status to display the right records. Use `isPublic` on statuses to decide which statuses to show customers. See [Order history](/frontend/domain-guides/orders-and-shipments/order-history).
5. **Payment integration** handles the payment flow after `cartProcess` creates an order with status `UNFINISHED`. See [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration).
6. **Shipment tracking** displays shipment statuses and track-and-trace codes for fulfilled orders.

---

## Order History

URL: https://docs.propeller-commerce.com/frontend/domain-guides/orders-and-shipments/order-history

# Order history

Fetch and display orders for a customer or contact in your portal. The `orders` query returns orders for the authenticated user automatically based on the access token. You do not need to pass a user ID. For B2B portals, use the `companyIds` filter to show all orders placed by colleagues within the same company.

For order status transitions and the overall lifecycle, see [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle). For shipment details, see [Shipment tracking](/frontend/domain-guides/orders-and-shipments/shipment-tracking).

## Listing orders

Use the `orders` query with the fields you need for a list view. The query returns a paginated response with order summaries.

### Query

```graphql
query Orders($input: OrderSearchArguments) {
  orders(input: $input) {
    items {
      id
      uuid
      status
      type
      createdAt
      currency
      reference
      companyId
      total {
        gross
        net
        tax
      }
    }
    itemsFound
    offset
    page
    pages
    start
    end
  }
}
```

### Variables

```json
{
  "input": {
    "page": 1,
    "offset": 10
  }
}
```

### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 277,
          "uuid": "019cb812-4a03-7128-a1f7-6e2d3b8c9f01",
          "status": "NEW",
          "type": "dropshipment",
          "createdAt": "2026-02-22T21:23:00.402Z",
          "currency": "EUR",
          "reference": null,
          "companyId": null,
          "total": {
            "gross": 695.08,
            "net": 841.05,
            "tax": 145.97
          }
        },
        {
          "id": 244,
          "uuid": "019c7543-8693-7954-bdc5-76acae4f8c92",
          "status": "CONFIRMED",
          "type": "dropshipment",
          "createdAt": "2026-02-19T09:38:05.649Z",
          "currency": "EUR",
          "reference": null,
          "companyId": 4,
          "total": {
            "gross": 3528.88,
            "net": 4269.94,
            "tax": 741.06
          }
        },
        {
          "id": 126,
          "uuid": "019b9e01-c2d4-7e12-b5a3-1f8d4c6e2a09",
          "status": "QUOTATION",
          "type": "quotation",
          "createdAt": "2026-02-04T09:12:02.172Z",
          "currency": "EUR",
          "reference": null,
          "companyId": 5,
          "total": {
            "gross": 1667.00,
            "net": 2017.07,
            "tax": 350.07
          }
        }
      ],
      "itemsFound": 236,
      "offset": 10,
      "page": 1,
      "pages": 24,
      "start": 1,
      "end": 10
    }
  }
}
```

The `total.gross` field is the order total excluding tax. The `total.net` field is the order total including tax.

> The `date` field on orders is deprecated. Use `createdAt` instead.

### Pagination fields

| Field | Type | Description |
|---|---|---|
| `itemsFound` | `Int!` | Total number of orders matching the filters |
| `offset` | `Int!` | Number of items per page |
| `page` | `Int!` | Current page number |
| `pages` | `Int!` | Total number of pages |
| `start` | `Int!` | Start position of the current page |
| `end` | `Int!` | End position of the current page |

## Pagination

Control the page size with `offset` and navigate pages with `page`. The default offset is 12.

### Query

```graphql
query OrdersPaginated($input: OrderSearchArguments) {
  orders(input: $input) {
    items {
      id
      status
      createdAt
      total {
        gross
        net
      }
    }
    itemsFound
    page
    pages
  }
}
```

### Variables

```json
{
  "input": {
    "page": 2,
    "offset": 5
  }
}
```

### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 242,
          "status": "CONFIRMED",
          "createdAt": "2026-02-09T12:40:24.081Z",
          "total": {
            "gross": 583.67,
            "net": 706.24
          }
        },
        {
          "id": 243,
          "status": "NEW",
          "createdAt": "2026-02-09T14:21:37.188Z",
          "total": {
            "gross": 412.30,
            "net": 498.88
          }
        }
      ],
      "itemsFound": 236,
      "page": 2,
      "pages": 48
    }
  }
}
```

## Sorting orders

Use the `sortInputs` field to control the order of results. Each sort input takes a `field` and an `order` (ASC or DESC).

### Query

```graphql
query OrdersSorted($input: OrderSearchArguments) {
  orders(input: $input) {
    items {
      id
      status
      createdAt
      total {
        gross
      }
    }
    itemsFound
  }
}
```

### Variables

```json
{
  "input": {
    "sortInputs": [{ "field": "CREATED_AT", "order": "DESC" }],
    "page": 1,
    "offset": 3
  }
}
```

### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 277,
          "status": "NEW",
          "createdAt": "2026-02-22T21:23:00.402Z",
          "total": {
            "gross": 695.08
          }
        },
        {
          "id": 244,
          "status": "CONFIRMED",
          "createdAt": "2026-02-19T09:38:05.649Z",
          "total": {
            "gross": 3528.88
          }
        },
        {
          "id": 243,
          "status": "NEW",
          "createdAt": "2026-02-09T14:21:37.188Z",
          "total": {
            "gross": 412.30
          }
        }
      ],
      "itemsFound": 236
    }
  }
}
```

### Sort fields

| Field | Description |
|---|---|
| `ID` | Sort by order ID |
| `CREATED_AT` | Sort by creation date |
| `LAST_MODIFIED_AT` | Sort by last modification date |
| `STATUS` | Sort by status alphabetically |
| `COMPANY` | Sort by company name |
| `TOTAL_GROSS` | Sort by order total (excluding tax) |
| `VALID_UNTIL` | Sort by validity expiration date |

## Filtering orders

The `OrderSearchArguments` input supports multiple filters. You can combine them in a single query.

### By status

Pass one or more status codes to filter orders by their current status. Status codes are strings like `NEW`, `CONFIRMED`, `QUOTATION` and `ARCHIVED`. For all available statuses and their meaning, see [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle).

#### Query

```graphql
query OrdersByStatus($input: OrderSearchArguments) {
  orders(input: $input) {
    items {
      id
      status
      type
      createdAt
      total {
        gross
        net
      }
    }
    itemsFound
  }
}
```

#### Variables

```json
{
  "input": {
    "status": ["CONFIRMED"],
    "sortInputs": [{ "field": "CREATED_AT", "order": "DESC" }],
    "page": 1,
    "offset": 3
  }
}
```

#### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 244,
          "status": "CONFIRMED",
          "type": "dropshipment",
          "createdAt": "2026-02-19T09:38:05.649Z",
          "total": {
            "gross": 3528.88,
            "net": 4269.94
          }
        },
        {
          "id": 242,
          "status": "CONFIRMED",
          "type": "dropshipment",
          "createdAt": "2026-02-09T12:40:24.081Z",
          "total": {
            "gross": 583.67,
            "net": 706.24
          }
        }
      ],
      "itemsFound": 66
    }
  }
}
```

### By date range

Use the `createdAt` field with `greaterThan` and `lessThan` to filter by date range. Both values are date strings.

#### Variables

```json
{
  "input": {
    "createdAt": {
      "greaterThan": "2026-02-01",
      "lessThan": "2026-02-28"
    }
  }
}
```

You can also use `lastModifiedAt` with the same `greaterThan` and `lessThan` structure to filter by when orders were last updated.

### By company (B2B)

For B2B portals where contacts can view orders placed by anyone in their company, filter by `companyIds`. In B2B, orders belong to the company, not the individual. A procurement manager needs to see all orders placed by any contact in the company to track spending across departments and follow up on deliveries. The `companyIds` filter enables this company-wide view. Without it, a contact only sees their own orders.

#### Variables

```json
{
  "input": {
    "companyIds": [4],
    "page": 1,
    "offset": 3
  }
}
```

#### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 244,
          "status": "CONFIRMED",
          "createdAt": "2026-02-19T09:38:05.649Z",
          "companyId": 4
        },
        {
          "id": 243,
          "status": "NEW",
          "createdAt": "2026-02-09T14:21:37.188Z",
          "companyId": 4
        }
      ],
      "itemsFound": 117
    }
  }
}
```

### By order type

Filter by `type` to separate regular orders from quotations or other order types.

| Type | Description |
|---|---|
| `dropshipment` | Standard order |
| `purchase` | Purchase order |
| `quotation` | Quotation or price request |
| `stock` | Stock order |

#### Variables

```json
{
  "input": {
    "type": ["quotation"]
  }
}
```

### By price range

Use the `price` field to filter orders by their total. The `price` input supports `greaterThan`, `lessThan` and `equal`.

#### Variables

```json
{
  "input": {
    "price": {
      "greaterThan": 500,
      "lessThan": 5000
    }
  }
}
```

### By channel

The `orders` query returns orders from all channels by default. In multi-channel setups where the same user may have orders across different storefronts, pass `channelId` as an input parameter to filter orders to a specific channel.

## Searching orders

Use `term` with `termFields` to search across order data. The `term` performs a text search and `termFields` specifies which fields to match against. If `termFields` is omitted, the search runs across multiple fields.

### Query

```graphql
query SearchOrders($input: OrderSearchArguments) {
  orders(input: $input) {
    items {
      id
      status
      createdAt
      items {
        name
        sku
        quantity
      }
    }
    itemsFound
  }
}
```

### Variables

```json
{
  "input": {
    "term": "EcoSpot",
    "termFields": ["ITEM_NAME"]
  }
}
```

### Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 244,
          "status": "CONFIRMED",
          "createdAt": "2026-02-19T09:38:05.649Z",
          "items": [
            {
              "name": "EcoSpot Recessed Downlight",
              "sku": "EL-ESD1",
              "quantity": 10
            },
            {
              "name": "Eclipse Elite LED Desk Lamp",
              "sku": "LL-EEDL01",
              "quantity": 5
            }
          ]
        },
        {
          "id": 243,
          "status": "NEW",
          "createdAt": "2026-02-09T14:21:37.188Z",
          "items": [
            {
              "name": "Hidden Glow Wall Washer",
              "sku": "GT-HGW1",
              "quantity": 1
            },
            {
              "name": "EcoSpot Recessed Downlight",
              "sku": "EL-ESD1",
              "quantity": 1
            }
          ]
        }
      ],
      "itemsFound": 21
    }
  }
}
```

### Search fields

The most commonly used search fields for a customer portal:

| Field | Description |
|---|---|
| `ID` | Order ID |
| `REFERENCE` | Customer reference number |
| `ITEM_NAME` | Product name on the order line |
| `ITEM_SKU` | Product SKU on the order line |
| `RECIPIENT_FIRST_NAME` | First name on the delivery address |
| `RECIPIENT_LAST_NAME` | Last name on the delivery address |
| `RECIPIENT_COMPANY` | Company name on the delivery address |
| `REMARKS` | Order remarks |

Other available fields include `INVOICE_ADDRESS_COMPANY`, `INVOICE_ADDRESS_FIRST_NAME`, `INVOICE_ADDRESS_LAST_NAME`, `RECIPIENT_EMAIL`, `ITEM_EAN_CODE`, `ITEM_MANUFACTURER`, `ITEM_SUPPLIER`, `ACCOUNTING_ID` and `DEBTOR_ID`.

## Fetching a single order

### By order ID

Use the `order` query to fetch full details for a single order. This includes items, addresses, totals, shipping and payment data.

#### Query

```graphql
query OrderDetail($orderId: Int!) {
  order(orderId: $orderId) {
    id
    uuid
    status
    type
    createdAt
    lastModifiedAt
    email
    reference
    remarks
    currency
    language
    companyId
    total {
      gross
      net
      tax
      discountType
      discountValue
      taxPercentages {
        percentage
        total
      }
    }
    items {
      id
      class
      productId
      sku
      name
      quantity
      price
      priceNet
      priceTotal
      priceTotalNet
      tax
      taxPercentage
      discount
      originalPrice
      notes
      product {
        productId
        names {
          value
          language
        }
        sku
        slugs {
          value
          language
        }
      }
    }
    deliveryAddress: addresses(type: delivery) {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      region
      country
      phone
      email
    }
    invoiceAddress: addresses(type: invoice) {
      firstName
      middleName
      lastName
      company
      street
      number
      numberExtension
      postalCode
      city
      region
      country
      phone
      email
    }
    postageData {
      method
      gross
      net
      tax
      taxPercentage
      carrier
      partialDeliveryAllowed
      requestDate
    }
    paymentData {
      method
      status
      gross
      net
      tax
      taxPercentage
    }
  }
}
```

#### Variables

```json
{
  "orderId": 244
}
```

#### Response

```json
{
  "data": {
    "order": {
      "id": 244,
      "uuid": "019c7543-8693-7954-bdc5-76acae4f8c92",
      "status": "CONFIRMED",
      "type": "dropshipment",
      "createdAt": "2026-02-19T09:38:05.649Z",
      "lastModifiedAt": "2026-02-19T09:53:41.263Z",
      "email": "lisa@brouwerindustrie.nl",
      "reference": null,
      "remarks": null,
      "currency": "EUR",
      "language": "NL",
      "companyId": 4,
      "total": {
        "gross": 3528.88,
        "net": 4269.94,
        "tax": 741.06,
        "discountType": "N",
        "discountValue": 0,
        "taxPercentages": [
          {
            "percentage": 21,
            "total": 741.06
          }
        ]
      },
      "items": [
        {
          "id": 26987,
          "class": "product",
          "productId": 44,
          "sku": "EL-ESD1",
          "name": "EcoSpot Recessed Downlight",
          "quantity": 10,
          "price": 309.14,
          "priceNet": 374.06,
          "priceTotal": 3091.42,
          "priceTotalNet": 3740.62,
          "tax": 649.20,
          "taxPercentage": 21,
          "discount": 33.40,
          "originalPrice": 342.54,
          "notes": "",
          "product": {
            "productId": 44,
            "names": [
              {
                "value": "EcoSpot Recessed Downlight",
                "language": "NL"
              }
            ],
            "sku": "EL-ESD1",
            "slugs": [
              {
                "value": "ecospot-recessed-downlight",
                "language": "NL"
              }
            ]
          }
        },
        {
          "id": 26992,
          "class": "product",
          "productId": 12,
          "sku": "LL-EEDL01",
          "name": "Eclipse Elite LED Desk Lamp",
          "quantity": 5,
          "price": 85.49,
          "priceNet": 103.44,
          "priceTotal": 427.45,
          "priceTotalNet": 517.22,
          "tax": 89.77,
          "taxPercentage": 21,
          "discount": 4.50,
          "originalPrice": 89.99,
          "notes": "",
          "product": {
            "productId": 12,
            "names": [
              {
                "value": "Eclipse Elite LED Desk Lamp",
                "language": "NL"
              }
            ],
            "sku": "LL-EEDL01",
            "slugs": [
              {
                "value": "eclipse-elite-led-desk-lamp",
                "language": "NL"
              }
            ]
          }
        }
      ],
      "deliveryAddress": [
        {
          "firstName": "Lisa",
          "middleName": null,
          "lastName": "de Vries",
          "company": "Brouwer Industrie",
          "street": "Keizersgracht",
          "number": "112",
          "numberExtension": null,
          "postalCode": "1016 GE",
          "city": "Amsterdam",
          "region": null,
          "country": "NL",
          "phone": "+31 20 123 4567",
          "email": "lisa@brouwerindustrie.nl"
        }
      ],
      "invoiceAddress": [
        {
          "firstName": "Lisa",
          "middleName": null,
          "lastName": "de Vries",
          "company": "Brouwer Industrie",
          "street": "Keizersgracht",
          "number": "112",
          "numberExtension": null,
          "postalCode": "1016 GE",
          "city": "Amsterdam",
          "region": null,
          "country": "NL",
          "phone": "+31 20 123 4567",
          "email": "finance@brouwerindustrie.nl"
        }
      ],
      "postageData": {
        "method": "REGULAR",
        "gross": 10.00,
        "net": 12.10,
        "tax": 2.10,
        "taxPercentage": 21,
        "carrier": null,
        "partialDeliveryAllowed": "N",
        "requestDate": "2026-02-06T09:20:53.728Z"
      },
      "paymentData": {
        "method": "ACCOUNT",
        "status": "UNKNOWN",
        "gross": 0,
        "net": 0,
        "tax": 0,
        "taxPercentage": 21
      }
    }
  }
}
```

### By UUID

You can also fetch an order by its UUID using the `orderUUID` parameter. This is useful when you use UUIDs in your frontend URLs instead of numeric IDs.

```graphql
query OrderByUUID($orderUUID: String!) {
  order(orderUUID: $orderUUID) {
    id
    status
    createdAt
  }
}
```

```json
{
  "orderUUID": "019c7543-8693-7954-bdc5-76acae4f8c92"
}
```

#### Response

```json
{
  "data": {
    "order": {
      "id": 244,
      "status": "CONFIRMED",
      "createdAt": "2026-02-19T09:38:05.649Z"
    }
  }
}
```

The `order` query accepts either `orderId` or `orderUUID`. You do not need to provide both.

## Order items

Each order contains an `items` array with all order lines. Items have a `class` field that indicates what type of line item it is.

| Class | Description |
|---|---|
| `product` | A product the customer ordered |
| `incentive` | A bonus or free item added by a promotion |
| `surcharge` | An additional fee (handling, small order surcharge) |

When displaying items in a portal, you will typically show all items but may want to visually distinguish incentives and surcharges from regular products.

### Item pricing

Each item carries both unit and total pricing, with and without tax.

| Field | Description |
|---|---|
| `price` | Unit price excluding tax |
| `priceNet` | Unit price including tax |
| `priceTotal` | Total price excluding tax (price x quantity) |
| `priceTotalNet` | Total price including tax |
| `tax` | Total tax amount for this item |
| `taxPercentage` | Tax percentage applied |

### Discounts

If an item has a discount applied, the `discount` field contains the discount amount per unit and `originalPrice` contains the price before the discount was applied. When `discount` is `null` or `0`, no discount was applied.

### Linking to product pages

Use the `product` field on each item to get the product's `slugs` for building links to product detail pages. The `product` field returns `null` if the product has been deleted from the catalog since the order was placed.

## Order totals

The `total` field provides the financial summary for the entire order.

| Field | Type | Description |
|---|---|---|
| `gross` | `Float!` | Order total excluding tax |
| `net` | `Float!` | Order total including tax |
| `tax` | `Float!` | Total tax amount |
| `discountType` | `OrderDiscountType!` | Discount type: `N` (none), `P` (percentage), `A` (absolute) |
| `discountValue` | `Float!` | Discount value (percentage or absolute amount, depending on `discountType`) |
| `taxPercentages` | `[OrderTotalTaxPercentage!]!` | Tax breakdown per rate |

The `taxPercentages` array lists each tax rate applied to the order with its total. This is useful for invoices where you need to show the tax breakdown by rate.

```json
{
  "taxPercentages": [
    {
      "percentage": 21,
      "total": 741.06
    }
  ]
}
```

## Addresses

The `addresses` field on an order accepts a `type` argument to filter by address type: `delivery` or `invoice`. Use GraphQL aliases to fetch both delivery and invoice addresses in a single query.

```graphql
deliveryAddress: addresses(type: delivery) {
  firstName
  middleName
  lastName
  company
  street
  number
  numberExtension
  postalCode
  city
  country
}
invoiceAddress: addresses(type: invoice) {
  firstName
  middleName
  lastName
  company
  street
  number
  numberExtension
  postalCode
  city
  country
}
```

The `addresses` field returns an array because an order can technically have multiple addresses of the same type. In most cases there is one delivery address and one invoice address.

> If you need all addresses without filtering by type, use the `orderAddresses` field instead. This returns `[OrderAddress!]!` with a `type` field on each address.

## Shipping and payment summary

The `postageData` and `paymentData` fields contain the shipping and payment details set during checkout.

### postageData fields

| Field | Type | Description |
|---|---|---|
| `method` | `String!` | Shipping method name |
| `gross` | `Float!` | Shipping cost excluding tax |
| `net` | `Float!` | Shipping cost including tax |
| `tax` | `Float!` | Tax on shipping costs |
| `taxPercentage` | `Float!` | Tax percentage for shipping |
| `carrier` | `String` | Selected carrier name |
| `requestDate` | `DateTime` | Requested delivery date |
| `partialDeliveryAllowed` | `YesNo` | Whether partial delivery is allowed (`Y` or `N`) |

### paymentData fields

| Field | Type | Description |
|---|---|---|
| `method` | `String!` | Payment method name |
| `status` | `String` | Payment status |
| `gross` | `Float!` | Transaction cost excluding tax |
| `net` | `Float!` | Transaction cost including tax |
| `tax` | `Float!` | Tax on transaction costs |
| `taxPercentage` | `Float!` | Tax percentage for transaction costs |

For full payment tracking with individual transactions, see [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration). For shipment tracking with carrier details and tracking codes, see [Shipment tracking](/frontend/domain-guides/orders-and-shipments/shipment-tracking).

## Next steps

- [Shipment tracking](/frontend/domain-guides/orders-and-shipments/shipment-tracking) for tracking shipments and displaying carrier information
- [Reordering](/frontend/domain-guides/orders-and-shipments/reordering) to let customers reorder from previous orders
- [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) for order statuses and transitions
- [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration) for payment processing and transaction tracking

---

## Reordering

URL: https://docs.propeller-commerce.com/frontend/domain-guides/orders-and-shipments/reordering

# Reordering

Let customers reorder items from a previous order by fetching the order items and adding them to a new cart. This is a frontend flow that combines an order query with cart mutations. Propeller does not have a dedicated reorder mutation, so your application handles the logic.

Reordering is one of the most used features in B2B portals. Businesses regularly restock the same items (office supplies, raw materials, maintenance parts, safety equipment) and expect to do this with minimal clicks. A well-built reorder flow saves buyers significant time compared to searching for and adding each product individually.

For cart creation and item management, see [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management). For listing and filtering orders, see [Order history](/frontend/domain-guides/orders-and-shipments/order-history).

## How reordering works

A reorder flow has three steps:

1. Fetch the original order's items
2. Create a new cart (or use an existing one)
3. Add each product item to the cart

The cart uses current pricing. Prices may have changed since the original order was placed.

> Only order items with `class: product` should be reordered. Order items can also have classes like `incentive` or `surcharge`, which are system-generated and should not be added to the cart manually.

## Step 1: Fetch the order items

Query the original order and include the fields needed for reordering: `productId`, `quantity` and `class`. Include `sku` and `name` for display purposes.

### Query

```graphql
query OrderForReorder($orderId: Int!) {
  order(orderId: $orderId) {
    id
    items {
      id
      class
      productId
      sku
      name
      quantity
      notes
    }
  }
}
```

### Variables

```json
{
  "orderId": 2075
}
```

### Response

```json
{
  "data": {
    "order": {
      "id": 2075,
      "items": [
        {
          "id": 20151,
          "class": "product",
          "productId": 1187,
          "sku": "157957",
          "name": "Douglas Lariks fijn bezaagd ZWART",
          "quantity": 4,
          "notes": ""
        },
        {
          "id": 20152,
          "class": "product",
          "productId": 1139,
          "sku": "VFS-200",
          "name": "Ventilatie Filterset Fresh Air",
          "quantity": 2,
          "notes": ""
        },
        {
          "id": 20153,
          "class": "product",
          "productId": 204,
          "sku": "695123-3",
          "name": "Power cord 2x1.50 4.0mtr",
          "quantity": 3,
          "notes": ""
        }
      ]
    }
  }
}
```

Filter the items in your frontend to include only those where `class` is `product`. Discard items with `class` values like `incentive` or `surcharge`.

## Step 2: Create a new cart

If the customer does not already have an active cart, create one using `cartStart`.

### Mutation

```graphql
mutation CartStart {
  cartStart {
    cartId
  }
}
```

### Response

```json
{
  "data": {
    "cartStart": {
      "cartId": "019c9f63-c127-70ca-8bac-ec3dd43c8bfd"
    }
  }
}
```

If the customer already has an active cart, you can add the reorder items to it directly. See [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) for details on creating and managing carts.

## Step 3: Add items to the cart

For each product item from the order, call `cartAddItem` with the `productId` and `quantity`.

### Mutation

```graphql
mutation CartAddItem($id: String!, $input: CartAddItemInput!) {
  cartAddItem(id: $id, input: $input) {
    cartId
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
      product {
        productId
        names {
          value
          language
        }
        sku
      }
    }
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
    }
  }
}
```

### Variables

```json
{
  "id": "019c9f63-c127-70ca-8bac-ec3dd43c8bfd",
  "input": {
    "productId": 1187,
    "quantity": 4
  }
}
```

### Response

```json
{
  "data": {
    "cartAddItem": {
      "cartId": "019c9f63-c127-70ca-8bac-ec3dd43c8bfd",
      "items": [
        {
          "itemId": "019c9f63-da2c-7006-8aeb-f47c2b86d861",
          "productId": 1187,
          "quantity": 4,
          "price": 24.54,
          "priceNet": 29.69,
          "totalPrice": 98.16,
          "totalPriceNet": 118.77,
          "product": {
            "productId": 1187,
            "names": [
              {
                "value": "Douglas Lariks fijn bezaagd ZWART",
                "language": "NL"
              }
            ],
            "sku": "157957"
          }
        }
      ],
      "total": {
        "subTotal": 98.16,
        "subTotalNet": 118.77,
        "totalGross": 153.16,
        "totalNet": 185.32
      }
    }
  }
}
```

Repeat the `cartAddItem` call for each product item from the order. Each call returns the updated cart with all items and totals. For orders with many items, `cartItemBulk` (documented in [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management#bulk-item-operations)) is more efficient because it adds or updates all items in a single API call instead of sequential calls per item.

### CartAddItemInput fields

| Field | Type | Required | Description |
|---|---|---|---|
| `productId` | `Int!` | Yes | The product to add |
| `quantity` | `Int` | No | Quantity to add (default: `1`) |
| `notes` | `String` | No | Customer notes for this item |
| `clusterId` | `Int` | No | Cluster ID if the product belongs to a cluster |
| `price` | `Float` | No | Override price per unit (for external pricing only) |
| `childItems` | `[CartChildItemInput!]` | No | Child items for configurable cluster products |

## Handling unavailable products

Products from the original order may no longer be available. Before adding an item, you can check the product's status by including the `product` field in the order query:

```graphql
query OrderForReorder($orderId: Int!) {
  order(orderId: $orderId) {
    id
    items {
      id
      class
      productId
      quantity
      product {
        productId
        names {
          value
          language
        }
        sku
        status
        orderable
      }
    }
  }
}
```

Check the `product.status` and `product.orderable` fields before attempting to add the item to the cart. If `status` is not `A` (available) or `orderable` is `N`, the product cannot be ordered and you should inform the customer.

| Status | Meaning |
|---|---|
| `A` | Available |
| `N` | Not available |
| `P` | Phase out |
| `S` | Presale |
| `R` | Restricted |
| `T` | Out of stock |

> The `product` field on an order item can return `null` if the product has been deleted from the catalog since the order was placed. Handle this case in your frontend by showing a message that the product is no longer available.

## Pricing differences

The cart uses current pricing, not the prices from the original order. If you want to show the customer that prices have changed, you can compare the order item's `price` field (the price at the time of the original order) with the cart item's `price` field (the current price).

```graphql
query OrderWithPrices($orderId: Int!) {
  order(orderId: $orderId) {
    items {
      id
      class
      productId
      name
      quantity
      price
      priceNet
    }
  }
}
```

```json
{
  "data": {
    "order": {
      "items": [
        {
          "id": 26987,
          "class": "product",
          "productId": 44,
          "name": "EcoSpot Recessed Downlight",
          "quantity": 10,
          "price": 309.14,
          "priceNet": 374.06
        },
        {
          "id": 26992,
          "class": "product",
          "productId": 12,
          "name": "Eclipse Elite LED Desk Lamp",
          "quantity": 5,
          "price": 85.49,
          "priceNet": 103.44
        }
      ]
    }
  }
}
```

The order item `price` is the unit price excluding tax at the time the order was placed. The order item `priceNet` is the unit price including tax. Compare these with the cart item's `price` and `priceNet` after adding to identify any changes.

## Cluster products

If the original order contained products that belong to a cluster (variant products), include the `clusterId` when adding them to the cart. You can retrieve the cluster ID from the order item's product:

```graphql
query OrderForReorder($orderId: Int!) {
  order(orderId: $orderId) {
    items {
      id
      class
      productId
      quantity
      product {
        productId
        cluster {
          clusterId
        }
      }
    }
  }
}
```

```json
{
  "data": {
    "order": {
      "items": [
        {
          "id": 25978,
          "class": "product",
          "productId": 45,
          "quantity": 1,
          "product": {
            "productId": 45,
            "cluster": null
          }
        },
        {
          "id": 25981,
          "class": "product",
          "productId": 56,
          "quantity": 1,
          "product": {
            "productId": 56,
            "cluster": {
              "clusterId": 1
            }
          }
        }
      ]
    }
  }
}
```

When `product.cluster` is not null, pass the `clusterId` to `cartAddItem`:

```json
{
  "id": "019c9f63-c127-70ca-8bac-ec3dd43c8bfd",
  "input": {
    "productId": 1187,
    "quantity": 4,
    "clusterId": 52
  }
}
```

## Next steps

- [Order history](/frontend/domain-guides/orders-and-shipments/order-history) for listing and filtering orders
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) for creating carts and managing items
- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) for completing the checkout after reordering

---

## Shipment Tracking

URL: https://docs.propeller-commerce.com/frontend/domain-guides/orders-and-shipments/shipment-tracking

# Shipment tracking

Display shipment information, delivery statuses and tracking codes for orders. After an order is confirmed, shipments track the physical fulfillment. Each shipment contains a subset of the order's items and can carry track and trace codes for carrier tracking. An order can have multiple shipments for partial deliveries.

For order statuses and the overall order lifecycle, see [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle). For listing and filtering orders, see [Order history](/frontend/domain-guides/orders-and-shipments/order-history).

## Shipment statuses

The `ShipmentStatus` enum tracks the delivery state of a shipment.

| Status | Description |
|---|---|
| `CREATED` | Shipment record created |
| `PROCESSING` | Shipment is being prepared |
| `IN_TRANSIT` | Picked up by the carrier |
| `OUT_FOR_DELIVERY` | Out for final delivery |
| `DELIVERED` | Successfully delivered |
| `PARTIALLY_DELIVERED` | Some items in the shipment delivered |
| `FAILED_DELIVERY` | Delivery attempt failed |
| `CANCELED` | Shipment canceled |
| `EXCEPTION` | An exception occurred during delivery |

## Fetching shipments for an order

There are two ways to fetch shipments: nested inside an order query or via the standalone `shipments` query.

### Via the order query

Include the `shipments` field when querying an order to get all shipments inline.

#### Query

```graphql
query OrderWithShipments($orderId: Int!) {
  order(orderId: $orderId) {
    id
    status
    shipments {
      id
      status
      expectedDeliveryAt
      createdAt
      items {
        id
        name
        sku
        quantity
        orderItemId
      }
      trackAndTraces {
        id
        code
        carrierId
        carrier {
          id
          name
          trackAndTraceURL
        }
      }
    }
  }
}
```

#### Variables

```json
{
  "orderId": 2075
}
```

#### Response

```json
{
  "data": {
    "order": {
      "id": 2075,
      "status": "CONFIRMED",
      "shipments": [
        {
          "id": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "status": "CREATED",
          "expectedDeliveryAt": "2025-12-05T10:00:00.000Z",
          "createdAt": "2025-11-03T14:34:48.828Z",
          "items": [
            {
              "id": "bda8e812-4238-49b4-aafc-6a153e265d59",
              "name": "Douglas Lariks fijn bezaagd ZWART",
              "sku": "157957",
              "quantity": 4,
              "orderItemId": 20151
            },
            {
              "id": "781dd85a-6ba4-4bd0-9399-6d3bb1632b1a",
              "name": "Ventilatie Filterset Fresh Air",
              "sku": "VFS-200",
              "quantity": 2,
              "orderItemId": 20152
            }
          ],
          "trackAndTraces": [
            {
              "id": "2d1860e6-e58c-41b8-b9d7-689b355b0c52",
              "code": "3STEST1234567890",
              "carrierId": 1,
              "carrier": {
                "id": 1,
                "name": "PostNL",
                "trackAndTraceURL": "https://postnl.nl/tracktrace/?B={code}"
              }
            }
          ]
        }
      ]
    }
  }
}
```

> Shipment IDs are UUIDs (strings), not integers. The `id` argument on the `shipment` query expects a `String!`.

### Via the shipments query

The standalone `shipments` query returns a paginated list and supports filtering by order IDs, statuses and date ranges. Use this when you need to list shipments across multiple orders or apply filters.

#### Query

```graphql
query ShipmentsByOrder($input: ShipmentSearchInput) {
  shipments(input: $input) {
    items {
      id
      status
      orderId
      expectedDeliveryAt
      createdAt
      items {
        id
        name
        sku
        quantity
        orderItemId
      }
      trackAndTraces {
        id
        code
        carrierId
        carrier {
          id
          name
          trackAndTraceURL
        }
      }
    }
    itemsFound
    page
    pages
    offset
    start
    end
  }
}
```

#### Variables

```json
{
  "input": {
    "orderIds": [2075],
    "page": 1,
    "offset": 12
  }
}
```

#### Response

```json
{
  "data": {
    "shipments": {
      "items": [
        {
          "id": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "status": "CREATED",
          "orderId": 2075,
          "expectedDeliveryAt": "2025-12-05T10:00:00.000Z",
          "createdAt": "2025-11-03T14:34:48.828Z",
          "items": [
            {
              "id": "bda8e812-4238-49b4-aafc-6a153e265d59",
              "name": "Douglas Lariks fijn bezaagd ZWART",
              "sku": "157957",
              "quantity": 4,
              "orderItemId": 20151
            },
            {
              "id": "781dd85a-6ba4-4bd0-9399-6d3bb1632b1a",
              "name": "Ventilatie Filterset Fresh Air",
              "sku": "VFS-200",
              "quantity": 2,
              "orderItemId": 20152
            }
          ],
          "trackAndTraces": [
            {
              "id": "2d1860e6-e58c-41b8-b9d7-689b355b0c52",
              "code": "3STEST1234567890",
              "carrierId": 1,
              "carrier": {
                "id": 1,
                "name": "PostNL",
                "trackAndTraceURL": "https://postnl.nl/tracktrace/?B={code}"
              }
            }
          ]
        }
      ],
      "itemsFound": 1,
      "page": 1,
      "pages": 1,
      "offset": 12,
      "start": 1,
      "end": 1
    }
  }
}
```

## Fetching a single shipment

Use the `shipment` query to fetch a specific shipment by its ID. This is useful for a shipment detail page where you want the full shipment data including item details from the original order.

### Query

```graphql
query Shipment($id: String!) {
  shipment(id: $id) {
    id
    status
    orderId
    expectedDeliveryAt
    createdAt
    lastModifiedAt
    items {
      id
      name
      sku
      quantity
      orderItemId
      shipmentId
      orderItem {
        id
        name
        sku
        quantity
        price
        priceNet
        productId
      }
    }
    trackAndTraces {
      id
      code
      carrierId
      shipmentId
      createdAt
      carrier {
        id
        name
        type
        trackAndTraceURL
        logo
      }
    }
  }
}
```

### Variables

```json
{
  "id": "65ad4404-88a6-4f97-9325-34a3a35f1dfc"
}
```

### Response

```json
{
  "data": {
    "shipment": {
      "id": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
      "status": "CREATED",
      "orderId": 2075,
      "expectedDeliveryAt": "2025-12-05T10:00:00.000Z",
      "createdAt": "2025-11-03T14:34:48.828Z",
      "lastModifiedAt": "2025-11-03T14:34:48.828Z",
      "items": [
        {
          "id": "bda8e812-4238-49b4-aafc-6a153e265d59",
          "name": "Douglas Lariks fijn bezaagd ZWART",
          "sku": "157957",
          "quantity": 4,
          "orderItemId": 20151,
          "shipmentId": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "orderItem": {
            "id": 20151,
            "name": "2,1X19,5X300cm Douglas / Lariks fijn bezaagd ZWART (Op=Op)",
            "sku": "157957",
            "quantity": 4,
            "price": 23.31,
            "priceNet": 28.21,
            "productId": 1187
          }
        },
        {
          "id": "781dd85a-6ba4-4bd0-9399-6d3bb1632b1a",
          "name": "Ventilatie Filterset Fresh Air",
          "sku": "VFS-200",
          "quantity": 2,
          "orderItemId": 20152,
          "shipmentId": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "orderItem": {
            "id": 20152,
            "name": "Ventilatie Filterset Fresh Air: 1x ePM10 (M5), 1x Coarse (G4)",
            "sku": "VFS-200",
            "quantity": 2,
            "price": 21.80,
            "priceNet": 26.38,
            "productId": 1139
          }
        }
      ],
      "trackAndTraces": [
        {
          "id": "2d1860e6-e58c-41b8-b9d7-689b355b0c52",
          "code": "3STEST1234567890",
          "carrierId": 1,
          "shipmentId": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "createdAt": "2025-11-03T14:34:48.828Z",
          "carrier": {
            "id": 1,
            "name": "PostNL",
            "type": "DELIVERY",
            "trackAndTraceURL": "https://postnl.nl/tracktrace/?B={code}",
            "logo": null
          }
        }
      ]
    }
  }
}
```

### Shipment fields

| Field | Type | Description |
|---|---|---|
| `id` | `String!` | UUID identifier |
| `orderId` | `Int!` | The order this shipment belongs to |
| `status` | `ShipmentStatus` | Current delivery status |
| `expectedDeliveryAt` | `DateTime` | Expected delivery date and time |
| `createdAt` | `DateTime!` | When the shipment was created |
| `lastModifiedAt` | `DateTime!` | When the shipment was last updated |
| `items` | `[ShipmentItem!]` | Products included in this shipment |
| `trackAndTraces` | `[TrackAndTrace!]` | Tracking codes for this shipment |

## Shipment items

Each shipment item represents a product from the order that is included in the shipment. The `orderItemId` links back to the original order line and the `orderItem` field returns the full order item with pricing and product details.

| Field | Type | Description |
|---|---|---|
| `id` | `String!` | UUID identifier |
| `name` | `String` | Item name (as recorded on the shipment) |
| `sku` | `String` | Product SKU |
| `quantity` | `Int` | Quantity shipped |
| `orderItemId` | `Int` | Reference to the original order item |
| `shipmentId` | `String!` | The shipment this item belongs to |
| `orderItem` | `OrderItem!` | Full order line details |

The `orderItem` field gives you access to the original order line including `name`, `sku`, `quantity` (the ordered quantity), `price` (unit price excluding tax), `priceNet` (unit price including tax) and `productId`. This is useful when the shipment item's `name` or `sku` differs from the order line or when you need pricing information.

> The `quantity` on a shipment item can differ from the `quantity` on the order item. For example, if a customer ordered 10 units and only 6 have shipped, the shipment item quantity is 6 while the order item quantity remains 10.

## Track and trace codes

Each shipment can have one or more track and trace codes. The `carrier` field on each track and trace returns the carrier's details including the `trackAndTraceURL` for building tracking links.

| Field | Type | Description |
|---|---|---|
| `id` | `String!` | UUID identifier |
| `code` | `String!` | Tracking code from the carrier |
| `carrierId` | `Int` | Carrier identifier |
| `shipmentId` | `String!` | The shipment this code belongs to |
| `carrier` | `Carrier` | Carrier details |

### Carrier fields

| Field | Type | Description |
|---|---|---|
| `id` | `Int!` | Carrier identifier |
| `name` | `String!` | Carrier name (e.g. `PostNL`, `DHL`, `DPD`) |
| `type` | `CarrierType!` | `DELIVERY` or `PICKUP` |
| `trackAndTraceURL` | `String` | URL template for tracking links |
| `logo` | `String` | Carrier logo URL |

### Building tracking links

When a carrier has a `trackAndTraceURL`, you can use it to build a tracking link for the customer. The URL typically contains a placeholder for the tracking code. Replace the placeholder with the `code` value from the track and trace record.

For example, if the carrier's `trackAndTraceURL` is `https://postnl.nl/tracktrace/?B={code}` and the tracking code is `3STEST1234567890`, the tracking link would be:

```
https://postnl.nl/tracktrace/?B=3STEST1234567890
```

> The `trackAndTraceURL` can be `null` if no URL template has been configured for the carrier. In that case, display the tracking code as plain text so the customer can look it up on the carrier's website manually.

## Filtering shipments

The `shipments` query accepts a `ShipmentSearchInput` with several filter options.

| Field | Type | Description |
|---|---|---|
| `page` | `Int!` | Page number (default: `1`) |
| `offset` | `Int!` | Items per page (default: `12`) |
| `orderIds` | `[Int!]` | Filter by one or more order IDs |
| `ids` | `[String!]` | Filter by one or more shipment IDs |
| `statuses` | `[ShipmentStatus!]` | Filter by one or more shipment statuses |
| `createdAt` | `DateSearchInput` | Filter by creation date range |
| `lastModifiedAt` | `DateSearchInput` | Filter by last modified date range |
| `expectedDeliveryAt` | `DateSearchInput` | Filter by expected delivery date range |
| `sortInputs` | `[ShipmentSortInput!]` | Sort order |

### Example: filter by status

```graphql
query InTransitShipments($input: ShipmentSearchInput) {
  shipments(input: $input) {
    items {
      id
      status
      orderId
      expectedDeliveryAt
      trackAndTraces {
        code
        carrier {
          name
          trackAndTraceURL
        }
      }
    }
    itemsFound
    page
    pages
  }
}
```

```json
{
  "input": {
    "statuses": ["IN_TRANSIT", "OUT_FOR_DELIVERY"],
    "page": 1,
    "offset": 20
  }
}
```

This returns all shipments that are currently in transit or out for delivery across all orders.

## Partial deliveries

An order can have multiple shipments when items are delivered in separate batches. Each shipment contains only the items and quantities included in that delivery.

To determine which items from an order have been shipped, compare the shipment items against the order items:

```graphql
query OrderWithShipmentDetails($orderId: Int!) {
  order(orderId: $orderId) {
    id
    status
    items {
      id
      name
      sku
      quantity
    }
    shipments {
      id
      status
      items {
        orderItemId
        quantity
      }
    }
  }
}
```

```json
{
  "orderId": 2075
}
```

```json
{
  "data": {
    "order": {
      "id": 2075,
      "status": "CONFIRMED",
      "items": [
        { "id": 20151, "name": "Douglas Lariks fijn bezaagd ZWART", "sku": "157957", "quantity": 4 },
        { "id": 20152, "name": "Ventilatie Filterset Fresh Air", "sku": "VFS-200", "quantity": 2 },
        { "id": 20153, "name": "Power cord 2x1.50 4.0mtr", "sku": "695123-3", "quantity": 3 },
        { "id": 20154, "name": "Printerstandaard voor ergonomische plaatsing", "sku": "STD-01", "quantity": 3 },
        { "id": 20155, "name": "Accu Cirkelzaag 18V Compact", "sku": "ACZ-18V", "quantity": 4 }
      ],
      "shipments": [
        {
          "id": "65ad4404-88a6-4f97-9325-34a3a35f1dfc",
          "status": "CREATED",
          "items": [
            { "orderItemId": 20151, "quantity": 4 },
            { "orderItemId": 20152, "quantity": 2 }
          ]
        }
      ]
    }
  }
}
```

In this example, order items 20151 and 20152 have been shipped in full. Order items 20153, 20154 and 20155 have not been shipped yet. You can use this comparison to show customers which items are still pending.

## Next steps

- [Order history](/frontend/domain-guides/orders-and-shipments/order-history) for listing and filtering orders
- [Reordering](/frontend/domain-guides/orders-and-shipments/reordering) for letting customers reorder from previous orders
- [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) for order statuses and transitions

---

## Customer-specific Pricing

URL: https://docs.propeller-commerce.com/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing

# Customer-specific pricing

Propeller supports pricing that varies by customer, company or user group. This page covers how customer-specific pricing works and how to handle it in your frontend.

## How customer-specific pricing works

When a user is authenticated, the GraphQL API automatically returns prices based on **price sheets** assigned to their company or customer group. All of this is handled server-side. When you query a product with an authenticated session, the `price` field already reflects the customer's specific pricing. You don't need to apply any discounts in your frontend code.

## Price sheets

Price sheets are the core mechanism for customer-specific pricing. A price sheet contains discount items that target specific products, categories or product groups. In B2B, price sheets typically represent negotiated pricing agreements between the merchant and the buyer's company. These agreements are often tied to annual contracts and may cover specific product categories, volume commitments or the entire catalog. When a contact logs in and belongs to a company with an assigned price sheet, all product prices automatically reflect the agreed rates.

Each price sheet has:

- **Priority** — a number that determines precedence. Lower numbers take priority over higher numbers.
- **Discount items** — individual pricing rules within the sheet. Each item specifies a discount type, value, optional volume thresholds and optional date-range validity.

### Discount calculation types

Each discount item uses one of three calculation methods:

| Type | Description | Example |
|---|---|---|
| `COST_PRICE_PLUS` | Cost price plus a percentage margin | Cost €40 + 25% = €50 |
| `LIST_PRICE_MIN` | List price minus a percentage | List €100 − 20% = €80 |
| `NET_PRICE` | Fixed amount (direct price) | Price = €75 |

### How overlapping discounts resolve

When multiple price sheet items apply to the same product:

1. The item from the price sheet with the **lowest priority number** wins
2. If priority numbers are equal, the item that produces the **lowest price** is selected
3. Orders outside configured volume ranges fall back to the **list price**

## Displaying customer prices

For anonymous users, the product price reflects the default pricing. For authenticated users, it reflects their price sheet pricing:

```graphql
query GetProductPrice($productId: Int, $taxZone: String) {
  product(productId: $productId) {
    price(input: { taxZone: $taxZone }) {
      gross
      net
      type
      discountType
      discount {
        value
        quantityFrom
      }
    }
    priceData {
      list
    }
  }
}
```

If the customer has a price sheet, `price.gross` and `price.net` will reflect the price sheet price. The `price.type` field will return `PRICESHEET` to indicate customer-specific pricing is active.

Compare `price.gross` against `priceData.list` to show savings. When the list price is higher than the customer price, display the difference as a discount. In B2B scenarios, consider showing a "Log in for your price" prompt for anonymous users.

Some B2B storefronts hide prices entirely for anonymous visitors and only show them after login. This is common in industries where pricing is confidential and varies significantly between customers. The `price.type` field helps you decide what label to show: "Your price" when the type is `PRICESHEET` (contract pricing) or "List price" when the type is `DEFAULT`.

## Action codes (discount codes)

Action codes are promotional codes that apply discounts at the cart level. Apply them with `cartAddActionCode`:

```graphql
mutation {
  cartAddActionCode(
    id: "018dcc9a-f965-7434-8fad-369aa9a8c276"
    input: { actionCode: "PROMO15" }
  ) {
    actionCode
    total {
      totalGross
      totalNet
      discount
      discountPercentage
    }
  }
}
```

Remove a code with `cartRemoveActionCode`:

```graphql
mutation {
  cartRemoveActionCode(
    id: "018dcc9a-f965-7434-8fad-369aa9a8c276"
    input: { actionCode: "PROMO15" }
  ) {
    actionCode
    total {
      totalGross
      totalNet
    }
  }
}
```

The mutation returns an error if the action code cannot be applied.

## Custom price overrides in the cart

When integrating with an external pricing system, you can override the calculated price per unit when adding an item to the cart:

```graphql
mutation {
  cartAddItem(
    id: "018dcc9a-f965-7434-8fad-369aa9a8c276"
    input: {
      productId: 67890
      quantity: 10
      price: 42.50
    }
  ) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
    }
    total {
      totalGross
      totalNet
    }
  }
}
```

The `price` field in the input overrides the calculated price for this item. This should only be used when integrating with external pricing systems.

## Next steps

- [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers) — price types, tax zones and surcharges
- [Tiered and volume pricing](/frontend/domain-guides/pricing-and-discounts/tiered-and-volume-pricing) — bulk discounts based on quantity
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — how prices and discounts flow into the cart

---

## Tiered and Volume Pricing

URL: https://docs.propeller-commerce.com/frontend/domain-guides/pricing-and-discounts/tiered-and-volume-pricing

# Tiered and volume pricing

Propeller supports bulk pricing — discounted prices that apply when a customer orders larger quantities. This page covers how to query and display tiered pricing.

## How bulk pricing works

Bulk prices are quantity-based price tiers configured on a product. When a customer adds a product to the cart with a quantity that falls within a bulk price tier, the lower price is automatically applied.

For example, a product might have:

| Quantity | Price (excl. tax) |
|---|---|
| 1–9 | €10.00 |
| 10–49 | €8.50 |
| 50+ | €7.00 |

Propeller calculates the correct price based on the cart quantity. You don't need to apply the tier logic in your frontend.

Orders outside configured volume tiers fall back to the list price.

## Discount calculation types

The `priceData.bulkPriceDiscountType` indicates how bulk discounts are calculated:

| Type | Description | Example |
|---|---|---|
| `COST_PRICE_PLUS` | Cost price plus a percentage margin | Cost €40 + 25% margin = €50 |
| `LIST_PRICE_MIN` | List price minus a percentage | List €100 − 20% = €80 |
| `NET_PRICE` | Fixed amount (direct price per unit) | Price = €75 |

## Querying bulk prices

Use the `bulkPrices` field on a product to retrieve the available price tiers:

```graphql
query GetBulkPrices($productId: Int, $taxZone: String) {
  product(productId: $productId) {
    price(input: { taxZone: $taxZone }) {
      gross
      net
      type
    }
    priceData {
      list
      bulkPriceDiscountType
    }
    bulkPrices(input: { taxZone: $taxZone }) {
      gross
      net
      discount {
        quantityFrom
        validFrom
        validTo
      }
    }
  }
}
```

**Response:**

```json
{
  "data": {
    "product": {
      "price": { "gross": 24.25, "net": 29.34, "type": "DEFAULT" },
      "priceData": { "list": 24.25, "bulkPriceDiscountType": "NET_PRICE" },
      "bulkPrices": [
        {
          "gross": 23.43, "net": 28.35,
          "discount": { "quantityFrom": 8, "validFrom": null, "validTo": null }
        },
        {
          "gross": 22.35, "net": 27.04,
          "discount": { "quantityFrom": 12, "validFrom": null, "validTo": null }
        },
        {
          "gross": 21.95, "net": 26.56,
          "discount": { "quantityFrom": 16, "validFrom": null, "validTo": null }
        },
        {
          "gross": 20.34, "net": 24.61,
          "discount": { "quantityFrom": 20, "validFrom": null, "validTo": null }
        }
      ]
    }
  }
}
```

### Bulk price fields

| Field | Description |
|---|---|
| `gross` | Tier price excluding tax |
| `net` | Tier price including tax |
| `discount.quantityFrom` | Minimum quantity for this tier to apply |
| `discount.validFrom` / `discount.validTo` | Date range when this tier is valid (null means no restriction) |

The `price.type` field returns `BULK_SALES_PRICE` or `BULK_COST_PRICE` when a bulk tier is active.

## Volume-based cost prices

Separately from bulk sales pricing, Propeller supports cost prices that vary by quantity. These are configured on the product's `priceData.costPrices` field:

```graphql
priceData {
  costPrices {
    quantityFrom
    value
  }
}
```

Each cost price has a `quantityFrom` threshold and a `value` per unit. Volume-based cost prices are used for margin calculations when the discount type is `COST_PRICE_PLUS`.

## Bulk pricing in the cart

When items are added to the cart, Propeller automatically applies the correct bulk price tier based on the total quantity. The cart response reflects the tiered price:

```graphql
query {
  cart(id: "018dcc9a-f965-7434-8fad-369aa9a8c276") {
    items {
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
  }
}
```

## Next steps

- [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers) — price types, tax zones and surcharges
- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) — price sheets, action codes and overrides
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) — include pricing in product listing queries

---

## Understanding Pricing Layers

URL: https://docs.propeller-commerce.com/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers

# Understanding pricing layers

Propeller has a multi-layered pricing model. Understanding how prices are structured helps you display the right data in product listings, detail pages and carts.

## Price types

Every product has several price fields:

| Field | Description |
|---|---|
| `gross` | Price **excluding** tax |
| `net` | Price **including** tax |
| `list` | Default sales price, used as the baseline for discount calculations |
| `store` | Price at which the product is sold at physical counter locations (common in building supplies, electrical wholesale and industrial parts distribution where the online price and counter price may differ) |
| `suggested` | Manufacturer's or supplier's recommended retail price (RRP) |
| `cost` | Purchase/cost price (deprecated in favor of `costPrices`) |
| `costPrices` | Quantity-based cost prices with a `quantityFrom` threshold and `value` per unit |

The `gross` and `net` values are the ones customers actually pay. The other price types are reference prices useful for showing savings or comparing prices.


Propeller uses `gross` and `net` differently from standard accounting. In most accounting contexts, "gross" means including tax and "net" means excluding tax. Propeller uses it the other way around: `gross` is the price **excluding** tax and `net` is the price **including** tax.


The `price` field returns the calculated price for the current context (user, tax zone, quantity). The `priceData` field returns the raw price configuration.

## Price source types

The `price.type` field tells you where the price came from:

| Type | Description |
|---|---|
| `DEFAULT` | Standard product price (list price) |
| `PRICESHEET` | Customer-specific price from a price sheet |
| `BULK_SALES_PRICE` | Bulk/volume discount on the sales price |
| `BULK_COST_PRICE` | Bulk/volume discount based on cost price |

Use this field to show context in your frontend, for example displaying a "Your price" label when `type` is `PRICESHEET`.

## Discount calculation types

The `price.discountType` and `priceData.bulkPriceDiscountType` fields indicate how discounts are calculated. Propeller supports three calculation methods:

| Type | Description | Example |
|---|---|---|
| `COST_PRICE_PLUS` | Cost price plus a percentage margin | Cost €40 + 25% = €50 |
| `LIST_PRICE_MIN` | List price minus a percentage | List €100 − 20% = €80 |
| `NET_PRICE` | Fixed amount (direct price) | Price = €75 |

## Tax zones

Prices vary by tax zone. Pass a `taxZone` to the price query to get the correct tax calculation for the customer's region. The `priceData.defaultTaxCode` indicates the product's default tax rate (`H` = high, `L` = low, `N` = none).

## How prices are resolved

When a product price is requested, Propeller evaluates pricing rules in this order:

1. **Customer-specific pricing (price sheets) always takes precedence** over product-level pricing when the user is authenticated and has applicable price sheets, even if product-level pricing would produce a lower price
2. Within price sheets, **lower priority numbers** take precedence
3. When multiple price sheets have the same priority, the **lowest price** is selected
4. When multiple discounts overlap in date range, the **lowest price** is selected
5. If no price sheet applies, **product-level bulk pricing** is evaluated
6. Orders outside configured volume ranges fall back to the **list price**
7. When no pricing rules apply, the product's **list price** is used

Price sheets take precedence by design because customer-specific pricing in B2B represents a negotiated contract. A contract price governs the relationship even when a temporary product-level promotion would produce a lower price.

This resolution happens server-side. Your frontend always receives the final calculated price.

## Price discounts

The `price.discount` field shows any discounts that apply to the product for the current user:

| Field | Description |
|---|---|
| `value` | Discount amount or percentage |
| `quantityFrom` | Minimum quantity to trigger the discount |
| `validFrom` / `validTo` | Discount validity period |

Discounts can come from price sheets or bulk pricing. See [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) for details.

## Surcharges

Surcharges are additional fees on top of the base price (handling fees, environmental charges, etc.).

| Field | Description |
|---|---|
| `type` | Surcharge type: `FlatFee` (fixed amount) or `Percentage` |
| `value` | The surcharge amount |
| `enabled` | Whether the surcharge is currently active |
| `validFrom` / `validTo` | Time window when the surcharge applies |

## Cart pricing

When products are added to a cart, Propeller recalculates all prices server-side, applying:

- Customer-specific pricing (price sheets)
- Quantity-based discounts (bulk pricing)
- Action codes (discount codes)
- Shipping costs
- Transaction fees
- Tax calculations

You don't need to calculate anything in your frontend. All totals are returned by the cart query. See [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) for details on cart totals.

## Next steps

- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) — price sheets, action codes and custom price overrides
- [Tiered and volume pricing](/frontend/domain-guides/pricing-and-discounts/tiered-and-volume-pricing) — bulk pricing and quantity discounts
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — how prices flow into the cart

---

## Categories and Navigation

URL: https://docs.propeller-commerce.com/frontend/domain-guides/products-and-catalog/categories-and-navigation

# Categories and navigation

Query the category tree, build navigation menus, display breadcrumbs and fetch category detail pages using Propeller's GraphQL API.

## Fetching categories

Use the `categories` query to retrieve the category tree. Categories have a parent-child hierarchy that you can use to build nested navigation.

```graphql
query GetCategories($language: String) {
  categories {
    items {
      ... on Category {
        categoryId
        name(language: $language) {
          value
        }
        parent {
          categoryId
          name(language: $language) {
            value
          }
        }
        categoryPath {
          categoryId
          name(language: $language) {
            value
          }
        }
      }
    }
    itemsFound
    page
    pages
  }
}
```

The response includes:
- `parent` — the direct parent category (null for top-level categories)
- `categoryPath` — the full hierarchy from root to the current category, useful for building breadcrumbs

### Filtering categories

The `categories` query accepts a `CategorySearchInput` to narrow results:

| Filter | Description |
|---|---|
| `categoryId` | Find categories by one or more IDs |
| `parentCategoryId` | Find child categories of a specific parent |
| `name` | Find categories by name (text search) |
| `slug` | Find categories by URL slug |
| `language` | Language to use when searching by name or slug |
| `hidden` | Filter by visibility (`Y` or `N`) |
| `sortField` | Sort results by `name`, `dateCreated` or `dateChanged` |
| `sortOrder` | Sort direction: `ASC` (default) or `DESC` |
| `page` / `offset` | Pagination controls |

To fetch only top-level categories, filter by the root parent ID. The root category ID varies per Propeller installation:

```graphql
query GetTopLevelCategories($language: String) {
  categories(filter: { parentCategoryId: [1] }) {
    items {
      ... on Category {
        categoryId
        name(language: $language) {
          value
        }
      }
    }
  }
}
```

To fetch subcategories of a specific category:

```graphql
query GetSubcategories($parentId: [Int!], $language: String) {
  categories(filter: { parentCategoryId: $parentId }) {
    items {
      ... on Category {
        categoryId
        name(language: $language) {
          value
        }
      }
    }
  }
}
```

## Category detail page

Fetch detailed information for a single category by slug:

```graphql
query GetCategoryDetails($slug: String, $language: String) {
  category(slug: $slug) {
    categoryId
    name {
      language
      value
    }
    description {
      language
      value
    }
    shortDescription {
      language
      value
    }
    slug(language: $language) {
      value
    }
    parent {
      categoryId
      name(language: $language) {
        value
      }
    }
    categoryPath {
      categoryId
      name(language: $language) {
        value
      }
      slug(language: $language) {
        value
      }
    }
  }
}
```

Use `categoryPath` to build a breadcrumb from the root category down to the current one.

## Building a breadcrumb

The `categoryPath` field returns the full hierarchy as an ordered array. Each entry contains the category name, slug and ID, which you can map to your breadcrumb component.

This also works on the `product` query — products have a `categoryPath` field that returns the hierarchy of their assigned category.

## Products within a category

To display products from a specific category, use the `products` query with a `categoryId` filter:

```graphql
query GetCategoryProducts($categoryId: Int, $language: String) {
  products(input: { categoryId: $categoryId }) {
    items {
      ... on Product {
        productId
        names(language: $language) {
          value
        }
        price {
          gross
          net
        }
      }
      ... on Cluster {
        names(language: $language) {
          value
        }
        defaultProduct {
          productId
          price {
            gross
            net
          }
        }
      }
    }
    itemsFound
    page
    pages
  }
}
```

This returns both products and clusters within the category. Combine with pagination, filters and sorting as described in [Querying products](/frontend/domain-guides/products-and-catalog/querying-products).

## Next steps

- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) — how clusters, products and attributes work
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) — filtering, pagination and search
- [Media and assets](/frontend/domain-guides/products-and-catalog/media-and-assets) — product images, videos and documents

---

## Media and Assets

URL: https://docs.propeller-commerce.com/frontend/domain-guides/products-and-catalog/media-and-assets

# Media and assets

Fetch and display product images, videos and documents using Propeller's GraphQL API. Images support server-side transformations so you can request exactly the sizes and formats your UI needs.

Propeller supports three media types:

| Type | Contains | Key field |
|---|---|---|
| Images | Product photos | `images` with `originalUrl`, `imageVariants` for transformed URLs |
| Videos | YouTube, Vimeo or hosted video URLs | `videos` with `uri` per language |
| Documents | PDFs, spec sheets, manuals | `documents` with `originalUrl` per language |

All media types support localized `alt` text, `description` and `tags`. The `priority` field controls display order.

## Querying product images

Use the `media` field on a product to fetch its images. Request `imageVariants` with named transformations to get URLs at the exact size you need.

```graphql
query GetProductImages($productId: Int!) {
  product(productId: $productId) {
    ... on Product {
      media {
        images(search: { sort: ASC, page: 1, offset: 12 }) {
          items {
            id
            alt {
              language
              value
            }
            description {
              language
              value
            }
            priority
            images {
              originalUrl
              mimeType
            }
            imageVariants(
              input: {
                transformations: [
                  {
                    name: "thumbnail"
                    transformation: {
                      width: 120
                      height: 120
                      fit: BOUNDS
                      bgColor: "transparent"
                      canvas: { width: 120, height: 120 }
                    }
                  }
                  {
                    name: "large"
                    transformation: {
                      width: 800
                      height: 800
                      fit: BOUNDS
                    }
                  }
                ]
              }
            ) {
              name
              url
            }
          }
          itemsFound
          page
          pages
        }
      }
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "product": {
      "media": {
        "images": {
          "items": [
            {
              "id": "cb853191-b9b4-4a0e-9240-f2168f1e0ef7",
              "alt": [
                {
                  "language": "NL",
                  "value": "Ergonomic desk chair front view"
                }
              ],
              "description": [
                {
                  "language": "NL",
                  "value": "Ergonomic desk chair front view"
                }
              ],
              "priority": 1,
              "images": [
                {
                  "originalUrl": "https://media.helice.cloud/example/images/en/cb853191-chair-front.jpg",
                  "mimeType": "image/jpeg"
                }
              ],
              "imageVariants": [
                {
                  "name": "thumbnail",
                  "url": "https://media.helice.cloud/example/images/en/cb853191-chair-front.jpg?bg-color=transparent&canvas=120,120&fit=bounds&height=120&width=120"
                },
                {
                  "name": "large",
                  "url": "https://media.helice.cloud/example/images/en/cb853191-chair-front.jpg?fit=bounds&height=800&width=800"
                }
              ]
            },
            {
              "id": "8c77dcfc-737e-4345-921e-25570aae9232",
              "alt": [
                {
                  "language": "NL",
                  "value": "Ergonomic desk chair side view"
                }
              ],
              "description": [
                {
                  "language": "NL",
                  "value": "Ergonomic desk chair side view"
                }
              ],
              "priority": 2,
              "images": [
                {
                  "originalUrl": "https://media.helice.cloud/example/images/en/8c77dcfc-chair-side.jpg",
                  "mimeType": "image/jpeg"
                }
              ],
              "imageVariants": [
                {
                  "name": "thumbnail",
                  "url": "https://media.helice.cloud/example/images/en/8c77dcfc-chair-side.jpg?bg-color=transparent&canvas=120,120&fit=bounds&height=120&width=120"
                },
                {
                  "name": "large",
                  "url": "https://media.helice.cloud/example/images/en/8c77dcfc-chair-side.jpg?fit=bounds&height=800&width=800"
                }
              ]
            }
          ],
          "itemsFound": 2,
          "page": 1,
          "pages": 1
        }
      }
    }
  }
}
```

Each image has two URL sources:

- `images` contains the original uploaded file with `originalUrl` and `mimeType`.
- `imageVariants` returns transformed URLs based on the transformations you define in the query. Each variant is identified by the `name` you assign.

Use `imageVariants` for display. Use `originalUrl` when you need the unmodified source file.

## Image transformations

The `imageVariants` field applies server-side transformations before returning the image URL. You define transformations in the query, so no client-side resizing is needed.

### Fit modes

The `fit` parameter controls how the image is constrained within the specified `width` and `height`. Both width and height must be specified for fit to take effect.

| Mode | Behavior |
|---|---|
| `BOUNDS` | Scales the image to fit within the dimensions, maintaining aspect ratio. The resulting image may be smaller than the specified size. |
| `COVER` | Scales the image to completely fill the dimensions, cropping if needed. |
| `CROP` | Resizes and crops the image centrally to exactly match the dimensions. |

### Output formats

Use the `format` parameter to control the output format:

| Format | Description |
|---|---|
| `AUTO` | Automatically selects the best format based on browser support and image characteristics. Recommended for most use cases. |
| `WEBP` | Good compression with transparency support. Widely supported. |
| `AVIF` | Best compression but slower to encode. Growing browser support. |
| `JPG` | Universal support. No transparency. |
| `PNG` | Lossless with transparency. Larger file sizes. |

Other formats available: `GIF`, `BJPG` (baseline JPEG), `PJPG` (progressive JPEG), `JXL` (JPEG XL), `PNG8` (palette PNG), `WEBPLL` (lossless WebP), `WEBPLY` (lossy WebP).

### Canvas and background color

Use `canvas` and `bgColor` together to produce images with consistent dimensions. This is useful for product listing grids where all thumbnails should be the same size regardless of the original image proportions.

```graphql
imageVariants(
  input: {
    transformations: [
      {
        name: "grid"
        transformation: {
          width: 200
          height: 200
          fit: BOUNDS
          bgColor: "transparent"
          canvas: { width: 200, height: 200 }
        }
      }
    ]
  }
) {
  name
  url
}
```

The image is first scaled to fit within 200×200 pixels (`fit: BOUNDS`), then placed on a 200×200 canvas. The remaining space is filled with the `bgColor`. This guarantees every image in the grid is exactly 200×200 pixels, with the product centered.

### Other transformation options

The transformation API supports additional parameters for advanced use cases:

| Parameter | Description |
|---|---|
| `quality` | Compression quality (1 to 100) |
| `dpr` | Device pixel ratio (1 to 10), for retina displays |
| `blur` | Gaussian blur (0.5 to 1000) |
| `brightness` | Brightness adjustment (-100 to 100) |
| `contrast` | Contrast adjustment (-100 to 100) |
| `saturation` | Saturation adjustment (-100 to 100) |
| `sharpen` | Sharpening settings |

## Requesting multiple sizes in one query

Pass an array of transformations to request multiple sizes in a single query. This is efficient for responsive images where you need a thumbnail, a medium size and a large detail image.

```graphql
imageVariants(
  input: {
    transformations: [
      {
        name: "thumbnail"
        transformation: {
          width: 100
          height: 100
          fit: BOUNDS
          bgColor: "transparent"
          canvas: { width: 100, height: 100 }
        }
      }
      {
        name: "medium"
        transformation: {
          width: 400
          height: 400
          fit: BOUNDS
          format: WEBP
        }
      }
      {
        name: "large"
        transformation: {
          width: 800
          height: 800
          fit: BOUNDS
          format: WEBP
        }
      }
    ]
  }
) {
  name
  url
}
```

Each variant in the response is identified by `name`, so you can pick the right URL for each context: `thumbnail` for product listing cards, `medium` for category pages and `large` for product detail galleries.

## Querying product videos

Use `media.videos` to fetch product videos:

```graphql
query GetProductVideos($productId: Int!) {
  product(productId: $productId) {
    ... on Product {
      media {
        videos(search: { sort: ASC, page: 1, offset: 12 }) {
          items {
            id
            alt {
              language
              value
            }
            description {
              language
              value
            }
            priority
            videos {
              language
              uri
              mimeType
            }
          }
          itemsFound
        }
      }
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "product": {
      "media": {
        "videos": {
          "items": [
            {
              "id": "67e62e23-1eb0-4ef8-b1a4-65bea27a7422",
              "alt": [
                {
                  "language": "NL",
                  "value": "Product demonstration video"
                }
              ],
              "description": [
                {
                  "language": "NL",
                  "value": "Product demonstration video"
                }
              ],
              "priority": 1,
              "videos": [
                {
                  "language": "NL",
                  "uri": "https://www.youtube.com/embed/example-product-demo",
                  "mimeType": "video/mp4"
                }
              ]
            }
          ],
          "itemsFound": 1
        }
      }
    }
  }
}
```

The `uri` field contains the video URL. This can be a YouTube embed URL, a Vimeo URL or any hosted video URL. Videos are localized, so different languages can have different video URIs.

## Querying product documents

Use `media.documents` to fetch downloadable files like spec sheets, manuals and safety data sheets:

```graphql
query GetProductDocuments($productId: Int!) {
  product(productId: $productId) {
    ... on Product {
      media {
        documents(search: { sort: ASC, page: 1, offset: 12 }) {
          items {
            id
            alt {
              language
              value
            }
            description {
              language
              value
            }
            priority
            documents {
              language
              originalUrl
              mimeType
            }
          }
          itemsFound
        }
      }
    }
  }
}
```

**Expected response:**

```json
{
  "data": {
    "product": {
      "media": {
        "documents": {
          "items": [
            {
              "id": "27760524-bce0-46ef-947d-464472f734fe",
              "alt": [
                {
                  "language": "NL",
                  "value": "Product specification sheet"
                }
              ],
              "description": [
                {
                  "language": "NL",
                  "value": "Product specification sheet"
                }
              ],
              "priority": 1,
              "documents": [
                {
                  "language": "en",
                  "originalUrl": "https://media.helice.cloud/example/documents/en/27760524-product-spec-sheet.pdf",
                  "mimeType": "application/pdf"
                }
              ]
            }
          ],
          "itemsFound": 1
        }
      }
    }
  }
}
```

Use `mimeType` to determine how to handle the file. For example, render PDFs inline or show a download button for other file types.

## Querying media by cluster or category

The `Cluster` and `Category` types do not have a `media` field directly. To fetch media for a cluster or category, use the root-level `media` query with a `clusterId` or `categoryId` filter:

```graphql
query GetClusterImages($clusterId: Int) {
  media {
    images(search: { clusterId: $clusterId, sort: ASC, page: 1, offset: 12 }) {
      items {
        id
        alt {
          language
          value
        }
        priority
        images {
          originalUrl
          mimeType
        }
        imageVariants(
          input: {
            transformations: [
              {
                name: "detail"
                transformation: {
                  width: 600
                  height: 600
                  fit: BOUNDS
                  format: WEBP
                }
              }
            ]
          }
        ) {
          name
          url
        }
      }
      itemsFound
    }
  }
}
```

The root `media` query accepts `productId`, `clusterId` and `categoryId` as filters in its search input. The same pattern works for `videos` and `documents`.

Alternatively, you can access cluster media through the cluster's products:

```graphql
query {
  cluster(clusterId: 456) {
    defaultProduct {
      media {
        images(search: { sort: ASC }) {
          items {
            id
            imageVariants(
              input: {
                transformations: [
                  {
                    name: "detail"
                    transformation: { width: 600, height: 600, fit: BOUNDS }
                  }
                ]
              }
            ) {
              name
              url
            }
          }
        }
      }
    }
  }
}
```

## Pagination and sorting

All media queries support pagination and sorting through the search input:

| Parameter | Default | Description |
|---|---|---|
| `page` | `1` | Current page number |
| `offset` | `12` | Number of items per page |
| `sort` | `ASC` | Sort direction: `ASC` or `DESC` |

The response includes pagination metadata:

| Field | Description |
|---|---|
| `itemsFound` | Total number of media items matching the query |
| `page` | Current page number |
| `pages` | Total number of pages |
| `offset` | Items per page |

Images are sorted by `priority`. A lower priority value means the image appears first when sorted `ASC`. Use priority to control which image is shown as the primary product photo.

## Next steps

- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) for how products, clusters and categories relate
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) for filtering, pagination and search
- [Get product images with responsive transformations](/frontend/recipes/get-product-images-with-transformations) for a ready-to-use recipe

---

## Product Detail Queries

URL: https://docs.propeller-commerce.com/frontend/domain-guides/products-and-catalog/product-detail-queries

# Product detail queries

Fetch detailed data for a single product including attributes, cross-sell relations and bundles. For listing queries (pagination, filtering, sorting), see [Querying products](/frontend/domain-guides/products-and-catalog/querying-products).

## Fetching a single product

Use the `product` query to retrieve a single product by `productId`, `slug` or `sku`:

```graphql
query GetProduct($slug: String, $language: String) {
  product(slug: $slug) {
    productId
    sku
    names(language: $language) {
      value
    }
    descriptions(language: $language) {
      value
    }
    shortDescriptions(language: $language) {
      value
    }
    slugs(language: $language) {
      value
    }
    manufacturer
    manufacturerCode
    status
    price {
      gross
      net
    }
    inventory {
      totalQuantity
    }
    cluster {
      clusterId
      names(language: $language) {
        value
      }
    }
    categoryPath {
      categoryId
      name(language: $language) {
        value
      }
    }
  }
}
```

**Variables:**

```json
{
  "slug": "led-paneel-backlit-60x60-3000k",
  "language": "NL"
}
```

**Response:**

```json
{
  "data": {
    "product": {
      "productId": 2151,
      "sku": "LED-PNL-6060-3K",
      "names": [{ "value": "LED Paneel Backlit 60x60 3000K" }],
      "descriptions": [{ "value": "<p>Compact backlit LED paneel van 60x60 cm...</p>" }],
      "shortDescriptions": [{ "value": "<p>Backlit LED paneel 60x60 cm, warm wit 3000K, voor systeemplafonds</p>" }],
      "slugs": [{ "value": "led-paneel-backlit-60x60-3000k" }],
      "manufacturer": "ProLight Solutions",
      "manufacturerCode": "PL-6060-BL-30",
      "status": "A",
      "price": { "gross": 39.95, "net": 48.34 },
      "inventory": { "totalQuantity": 250 },
      "cluster": {
        "clusterId": 214,
        "names": [{ "value": "LED Paneel Backlit" }]
      },
      "categoryPath": []
    }
  }
}
```

You can also look up by `productId` or `sku`:

```graphql
product(productId: 2151) { ... }
product(sku: "LED-PNL-6060-3K") { ... }
```

If the product belongs to a cluster, the `cluster` field returns the parent cluster. Use this to link back to the cluster page or show variant selectors. The `categoryPath` field returns the full category hierarchy for building breadcrumbs.

## Product attributes

Attributes are key-value pairs attached to products. Use the `attributes` field to fetch them for display as product specifications.

```graphql
query GetProductAttributes($productId: Int!, $language: String) {
  product(productId: $productId) {
    productId
    names(language: $language) {
      value
    }
    attributes(
      input: {
        offset: 20
        attributeDescription: { isPublic: true, isSearchable: true }
      }
    ) {
      items {
        attributeDescription {
          name
          descriptions {
            language
            value
          }
          type
          group
        }
        value {
          ... on AttributeColorValue {
            colorValue
          }
          ... on AttributeTextValue {
            textValues {
              language
              values
            }
          }
          ... on AttributeEnumValue {
            enumValues
          }
          ... on AttributeIntValue {
            intValue
          }
          ... on AttributeDecimalValue {
            decimalValue
          }
          ... on AttributeDateTimeValue {
            dateTimeValue
          }
        }
      }
      itemsFound
    }
  }
}
```

**Variables:**

```json
{
  "productId": 2151,
  "language": "NL"
}
```

**Response:**

```json
{
  "data": {
    "product": {
      "productId": 2151,
      "names": [{ "value": "LED Paneel Backlit 60x60 3000K" }],
      "attributes": {
        "items": [
          {
            "attributeDescription": {
              "name": "AFMETING_MM",
              "descriptions": [{ "language": "NL", "value": "Afmeting mm" }],
              "type": "TEXT",
              "group": null
            },
            "value": {
              "textValues": [{ "language": "NL", "values": ["60 x 60 cm"] }]
            }
          },
          {
            "attributeDescription": {
              "name": "KLEURTEMPERATUUR",
              "descriptions": [{ "language": "NL", "value": "Kleurtemperatuur in Kelvin" }],
              "type": "TEXT",
              "group": "LED verlichting"
            },
            "value": {
              "textValues": [{ "language": "NL", "values": ["3000K"] }]
            }
          }
        ],
        "itemsFound": 2
      }
    }
  }
}
```

Attribute values use different types depending on the attribute's `type`. Each type has its own fragment:

| Attribute type | Fragment | Value field |
|---|---|---|
| `TEXT` | `AttributeTextValue` | `textValues` (localized array) |
| `ENUM` | `AttributeEnumValue` | `enumValues` (string array) |
| `COLOR` | `AttributeColorValue` | `colorValue` (hex string) |
| `INT` | `AttributeIntValue` | `intValue` |
| `DECIMAL` | `AttributeDecimalValue` | `decimalValue` |
| `DATETIME` | `AttributeDateTimeValue` | `dateTimeValue` |

Include all six fragments in your query to handle any attribute type. The `attributeDescription` provides the human-readable label via `descriptions` and an optional `group` for organizing attributes into sections.

### Filtering attributes

The `attributeDescription` input controls which attributes are returned:

| Filter | Description |
|---|---|
| `isPublic` | Attributes intended for end-user display |
| `isSearchable` | Attributes used for catalog filtering |
| `names` | Filter by specific attribute names |
| `groups` | Filter by attribute group |
| `types` | Filter by attribute type (`TEXT`, `ENUM`, etc.) |

Set `includeDefaultValues` to `false` to only return attributes that have a value set on the product, excluding inherited defaults.

## Cross-sell and upsell

Products and clusters can have cross-sell and upsell relations. Use `crossupsellsFrom` to fetch them:

```graphql
query GetCrossSellProducts($productId: Int!, $language: String) {
  product(productId: $productId) {
    productId
    names(language: $language) {
      value
    }
    crossupsellsFrom(input: { offset: 12 }) {
      items {
        type
        subType
        productTo {
          ... on Product {
            productId
            names(language: $language) {
              value
            }
            price {
              gross
              net
            }
          }
        }
        clusterTo {
          ... on Cluster {
            clusterId
            names(language: $language) {
              value
            }
          }
        }
      }
      itemsFound
    }
  }
}
```

**Variables:**

```json
{
  "productId": 25,
  "language": "NL"
}
```

**Response:**

```json
{
  "data": {
    "product": {
      "productId": 25,
      "names": [{ "value": "Industriële Kachel HT-1001" }],
      "crossupsellsFrom": {
        "items": [
          {
            "type": "RELATED",
            "subType": null,
            "productTo": {
              "productId": 26,
              "names": [{ "value": "Industriële Kachel HT-350" }],
              "price": { "gross": 2275.21, "net": 2753.0 }
            },
            "clusterTo": null
          },
          {
            "type": "PARTS",
            "subType": null,
            "productTo": {
              "productId": 28,
              "names": [{ "value": "Vuurvaste Bodemplaat HT-425" }],
              "price": { "gross": 172.44, "net": 208.65 }
            },
            "clusterTo": null
          },
          {
            "type": "ACCESSORIES",
            "subType": null,
            "productTo": {
              "productId": 31,
              "names": [{ "value": "Hitteschild Links HT-101" }],
              "price": { "gross": 70.0, "net": 84.7 }
            },
            "clusterTo": null
          }
        ],
        "itemsFound": 22
      }
    }
  }
}
```

Each relation has a `type` that indicates the relationship. For the available types and their meaning, see [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories#cross-sell-and-upsell-relations).

Each relation points to either a `productTo` (a standalone product) or a `clusterTo` (a cluster), never both. Both fields return the `IBaseProduct` interface, so use inline fragments (`... on Product` and `... on Cluster`) to access type-specific fields like `productId`, `price` or `clusterId`.

## Bundle details

Products can be part of bundles. The `bundles` field returns all bundles where this product participates:

```graphql
query GetProductBundleDetails($productId: Int!, $language: String) {
  product(productId: $productId) {
    productId
    names(language: $language) {
      value
    }
    bundles {
      id
      name
      discount
      condition
      price {
        gross
        net
        originalGross
        originalNet
      }
      items {
        productId
        isLeader
        product {
          names(language: $language) {
            value
          }
          sku
          price {
            gross
            net
          }
        }
      }
    }
  }
}
```

**Variables:**

```json
{
  "productId": 2017,
  "language": "NL"
}
```

**Response:**

```json
{
  "data": {
    "product": {
      "productId": 2017,
      "names": [{ "value": "Ergonomische Bureaustoel Pro 300 Mesh Zwart" }],
      "bundles": [
        {
          "id": "019c9425-5eaf-72b5-9315-d7182932db45",
          "name": "Bureaustoel Pro + Vloermat",
          "discount": 10,
          "condition": "EP",
          "price": {
            "gross": 270.89,
            "net": 327.77,
            "originalGross": 272.65,
            "originalNet": 329.91
          },
          "items": [
            {
              "productId": 2017,
              "isLeader": "Y",
              "product": {
                "names": [{ "value": "Ergonomische Bureaustoel Pro 300 Mesh Zwart" }],
                "sku": "BST-PRO-300",
                "price": { "gross": 255.0, "net": 308.55 }
              }
            },
            {
              "productId": 2044,
              "isLeader": "N",
              "product": {
                "names": [{ "value": "Vloermat PVC Transparant 120 x 90 cm" }],
                "sku": "0123AA",
                "price": { "gross": 17.65, "net": 21.36 }
              }
            }
          ]
        }
      ]
    }
  }
}
```

The `isLeader` field (`Y` or `N`) identifies the main product in the bundle. The leader is the product the bundle is displayed on. Compare `originalGross`/`originalNet` (sum of individual prices) with `gross`/`net` (discounted bundle price) to show the savings.

To filter product listings to only products with bundle offers, use `hasBundle: Y` in `ProductSearchInput`. For adding bundles to a cart, see [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management).

## Next steps

- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) — how clusters, products, attributes and bundles work
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) — listing queries with filtering, pagination and search
- [Media and assets](/frontend/domain-guides/products-and-catalog/media-and-assets) — product images, videos and documents
- [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers) — price types, bulk prices and surcharges

---

## Querying Products

URL: https://docs.propeller-commerce.com/frontend/domain-guides/products-and-catalog/querying-products

# Querying products

Fetch products from the Propeller catalog using GraphQL. This page covers how to retrieve product listings, handle pagination, work with filters and deal with clusters (product groups) in your query results.

## Fetching products

The `products` query returns a paginated list of catalog items. Each item is either a **Product** (a single purchasable item) or a **Cluster** (a group of related products). Your query needs to handle both types.

```graphql
query GetProducts($language: String) {
  products {
    items {
      ... on Product {
        productId
        sku
        names(language: $language) {
          value
        }
        price {
          gross
          net
        }
        slugs(language: $language) {
          value
        }
        media {
          images(search: { sort: ASC, offset: 1 }) {
            items {
              alt(language: $language) {
                value
              }
              imageVariants(
                input: {
                  transformations: {
                    name: "small"
                    transformation: {
                      width: 50
                      height: 50
                      fit: BOUNDS
                      format: WEBP
                    }
                  }
                }
              ) {
                url
              }
            }
          }
        }
      }
      ... on Cluster {
        names(language: $language) {
          value
        }
        sku
        defaultProduct {
          productId
          price {
            gross
            net
          }
          slugs(language: $language) {
            value
          }
          media {
            images(search: { sort: ASC, offset: 1 }) {
              items {
                imageVariants(
                  input: {
                    transformations: {
                      name: "small"
                      transformation: {
                        width: 50
                        height: 50
                        fit: BOUNDS
                        format: WEBP
                      }
                    }
                  }
                ) {
                  url
                }
              }
            }
          }
        }
      }
    }
    itemsFound
    page
    pages
  }
}
```

The response contains both products and clusters in the same `items` array. For clusters, use `defaultProduct` to get the price, images and slug to display on a listing page. The cluster itself holds shared data like the name.

You can filter results to only products or only clusters using the `class` parameter in `ProductSearchInput` with values `PRODUCT` or `CLUSTER`.

## Pagination

Control how many products appear per page using `offset` (items per page) and `page` (current page number). The response includes `itemsFound`, `pages`, `start` and `end` so you can build pagination controls.

```graphql
query GetProducts($page: Int, $offset: Int) {
  products(input: { page: $page, offset: $offset }) {
    items {
      ... on Product {
        productId
      }
    }
    itemsFound
    start
    end
    page
    pages
  }
}
```

**Variables:**

```json
{
  "page": 2,
  "offset": 24
}
```

Categories and other list queries use the same pagination pattern.

## Filtering by attributes

Products have attributes (like color, size or material) that you can use as filters. First retrieve the available filters for the current product set, then pass selected values back into the query.

### Get available filters

```graphql
query CatalogQuery($input: ProductSearchInput) {
  products(input: $input) {
    filters(input: { isPublic: true, isSearchable: true }) {
      attributeDescription {
        name
        descriptions {
          language
          value
        }
      }
      textFilters {
        value
        count
        isSelected
      }
      decimalRangeFilter {
        min
        max
      }
      type
    }
    items {
      ... on Product {
        productId
      }
    }
    itemsFound
  }
}
```

The `filters` field returns two types: `textFilters` for discrete values (colors, brands) and `decimalRangeFilter` for numeric ranges (price, weight). Each text filter includes a `count` of matching products so you can show facet counts in your UI.

### Apply selected filters

Pass the user's selections back through `ProductSearchInput.textFilters` and `ProductSearchInput.rangeFilters`:

```graphql
query CatalogQuery {
  products(
    input: {
      term: "valve"
      price: { from: 0, to: 500 }
      textFilters: [{ name: "COLOR", values: ["red", "blue"] }]
    }
  ) {
    items {
      ... on Product {
        productId
      }
    }
    itemsFound
    page
    pages
  }
}
```

The `term` field performs a text search across product fields. Use `searchFields` to control which fields are included in the search. Filters combine with AND logic: the query above returns products matching "valve" that cost under 500 and are red or blue.

### ProductSearchInput reference

The `ProductSearchInput` type supports the following fields:

| Field | Description |
|---|---|
| `term` | Text search across product fields |
| `searchFields` | Control which fields `term` searches |
| `categoryId` | Filter by category |
| `textFilters` | Filter by text/enum attribute values |
| `rangeFilters` | Filter by numeric attribute ranges |
| `price` | Filter by price range (requires both `from` and `to`) |
| `sortInputs` | Sort by field (`NAME`, `PRICE`, `SKU`, `RELEVANCE`, etc.) |
| `manufacturers` | Filter by manufacturer name |
| `skus` | Filter by SKU codes |
| `statuses` | Filter by product status (default: active) |
| `hasBundle` | Filter to products with bundle offers (`Y` or `N`) |
| `isBundleLeader` | Filter to bundle leader products (`Y` or `N`) |
| `applyOrderlists` / `orderlistIds` | Restrict to orderlist assortment |
| `class` | Filter by `PRODUCT` or `CLUSTER` |
| `hidden` | Include or exclude hidden products |
| `containerSlugs` / `containerPathSlugs` | Filter by path slugs |
| `page` / `offset` | Pagination (default: page 1, 12 items per page) |

For the full schema definition see the [ProductSearchInput reference](/reference/graphql/inputs/product-search-input).

## Filtering by orderlist

In B2B commerce, different companies see different product assortments. Orderlists control which products are visible and orderable for a specific company. Pass orderlist IDs to restrict results to products the customer is allowed to see.

```graphql
query GetOrderListProducts {
  products(input: { applyOrderlists: true, orderlistIds: [1, 3, 678] }) {
    items {
      ... on Product {
        productId
      }
    }
    itemsFound
  }
}
```

When `applyOrderlists` is true, only products assigned to the specified orderlists are returned.

## Sorting results

Use `sortInputs` in `ProductSearchInput` to order results. Available sort fields include `NAME`, `PRICE`, `SKU`, `RELEVANCE`, `CREATED_AT`, `LAST_MODIFIED_AT`, `PRIORITY` and `CATEGORY_ORDER`.

```graphql
query GetProducts {
  products(input: { sortInputs: [{ field: NAME, order: ASC }] }) {
    items {
      ... on Product {
        productId
      }
    }
  }
}
```

## Including inventory in listings

You can include stock data directly in your product listing query to show availability badges or "in stock" indicators without a separate request.

```graphql
query GetProducts {
  products {
    items {
      ... on Product {
        productId
        inventory {
          totalQuantity
        }
      }
    }
  }
}
```

`totalQuantity` is the combined stock across all warehouses and suppliers. For a detailed breakdown by warehouse, see the recipe [Fetch product stock across warehouses](/frontend/recipes/fetch-product-stock).

---

## Understanding Products and Categories

URL: https://docs.propeller-commerce.com/frontend/domain-guides/products-and-catalog/understanding-products-and-categories

# Understanding products and categories

Propeller's catalog is built around two core types: **products** and **clusters**. A product is the standalone, purchasable unit. A cluster groups multiple products together as variants of the same item. Both live inside a category tree and can carry cross-sell and upsell relations, pricing, inventory, attributes and media.

## Products

A product (`class: PRODUCT`) is the fundamental unit in Propeller. Every item that can be ordered, priced and stocked is a product. Products are identified by their `productId`.

### Core fields

Each product carries identification and descriptive fields:

| Field | Description |
|---|---|
| `sku` | Stock keeping unit code |
| `eanCode` | European Article Number |
| `barCode` | Barcode |
| `names` | Product name, localized per language |
| `shortNames` | Abbreviated name, used in compact displays like order lines |
| `descriptions` | Full description (localized, supports HTML) |
| `shortDescriptions` | Short description (localized, supports HTML) |
| `manufacturer` | Manufacturer name |
| `manufacturerCode` | Manufacturer's own product code |
| `supplier` | Supplier name |
| `supplierCode` | Supplier's own product code |

### Ordering and packaging

Products define how they can be ordered and how they are packaged:

| Field | Description |
|---|---|
| `unit` | The base unit in which the product is ordered |
| `minimumQuantity` | Minimum order quantity |
| `economicOrderQuantity` | The quantity that provides the best value |
| `purchaseUnit` | Unit for purchase orders |
| `purchaseMinimumQuantity` | Minimum quantity for purchase orders |
| `package` | Package type (e.g. `BOX`) |
| `packageUnit` | What one item in the package looks like (e.g. `PC`) |
| `packageUnitQuantity` | Number of items per package |

### Status

Every product has a `status` that controls its availability:

| Status | Meaning |
|---|---|
| `A` | Available |
| `N` | Not available |
| `P` | Phase out |
| `S` | Presale |
| `R` | Restricted |
| `T` | Out of stock |

Additional flags control visibility and behavior: `hidden` (Y/N), `orderable` (Y/N) and `physical` (Y/N, indicating whether it is a physical product or something like a service or warranty).

### Standalone vs. cluster products

A product can exist on its own (standalone) or as a variant inside a cluster. The `containerClass` field tells you which situation applies:

- `CATEGORY` means the product lives standalone in a category.
- `CLUSTER` means the product belongs to a cluster. You can navigate to its parent cluster via the `cluster` field.

### SEO metadata

Products carry localized SEO fields: `metadataTitles`, `metadataDescriptions`, `metadataKeywords` and `metadataCanonicalUrls`.

## Clusters

A cluster (`class: CLUSTER`) groups multiple products together as variants of the same item. Clusters are identified by their `clusterId`. Where a product is what gets ordered, a cluster is the presentation layer that ties variants together on a single product page.

### Cluster-level vs. product-level data

Clusters have their own `names`, `descriptions` and `shortDescriptions`. These are shared presentation data that apply to all variants. Each product inside the cluster carries its own variant-specific data: its own `sku`, `names`, pricing, inventory and attribute values.

### Cluster configuration

Every cluster has a `config` (ClusterConfig) that defines which attributes differentiate its variants. The config contains settings, each specifying:

| Setting field | Description |
|---|---|
| `name` | The attribute name that varies across products (e.g. `AFMETING_MM`, `KLEURTEMPERATUUR`) |
| `displayType` | How the selector should render: `DROPDOWN`, `RADIO`, `IMAGE` or `COLOR` |
| `priority` | Display order (0 is first) |

For example, an LED panel cluster uses config settings `AFMETING_MM` (priority 0) and `KLEURTEMPERATUUR` (priority 1). Each product in the cluster then has specific values for these attributes:

```
Cluster: "LED Paneel Backlit"
├── LED Paneel Backlit 60x60 3000K   (AFMETING_MM: 60 x 60 cm, KLEURTEMPERATUUR: 3000K)
├── LED Paneel Backlit 60x60 4000K   (AFMETING_MM: 60 x 60 cm, KLEURTEMPERATUUR: 4000K)
├── LED Paneel Backlit 60x60 6000K   (AFMETING_MM: 60 x 60 cm, KLEURTEMPERATUUR: 6000K)
├── LED Paneel Backlit 30x120 3000K  (AFMETING_MM: 30 x 120 cm, KLEURTEMPERATUUR: 3000K)
├── LED Paneel Backlit 30x120 4000K  (AFMETING_MM: 30 x 120 cm, KLEURTEMPERATUUR: 4000K)
└── ...
```

### Default product

Every cluster has a `defaultProduct`. This is the variant that should be shown when no specific selection has been made, for example on listing pages where you need a representative price and image.

### Cluster options

Clusters can have **options**, which are add-on product groups. Options are not variants. They represent additional items a customer can select alongside the main product, such as accessories or service add-ons.

Each option has its own `names`, `descriptions`, an `isRequired` flag (Y/N) and a list of `products` to choose from. An option can also have a `defaultProduct`.

For example, the LED panel cluster has two options:

- **Opbouwframe** (optional): mounting frames in different sizes, 3 products to choose from.
- **Noodverlichting module** (optional): emergency lighting modules, 2 products to choose from.

## Categories

Products and clusters are organized into categories. Categories form a tree structure where each category has a `parent` (except root categories) and can have child `categories`.

Each product and cluster belongs to one primary category via `categoryId`. The `categoryPath` field returns the full hierarchy from root to the assigned category, which is useful for building breadcrumbs. Products can also be linked to additional categories, allowing them to appear in multiple places in the catalogue structure without duplication.

Example from a real catalog:

```
PDM (root)
├── Bureaustoelen
│   ├── EM bureaustoelen
│   ├── Interstuhl bureaustoelen
│   └── ...
├── Elektrotechnisch & Industrieel Installatiemateriaal
│   ├── LED verlichting
│   └── ...
└── ...
```

For practical details on querying and navigating categories, see [Categories and navigation](/frontend/domain-guides/products-and-catalog/categories-and-navigation).

## Cross-sell and upsell relations

Products and clusters can have cross-sell and upsell relations via `crossupsellsFrom`. Each relation has a `type` and an optional `subType`:

| Type | Purpose |
|---|---|
| `ACCESSORIES` | Complementary items (e.g. a floor mat for a desk chair) |
| `ALTERNATIVES` | Substitute products (e.g. a different brand of chair) |
| `RELATED` | Related items from the same category or brand |
| `PARTS` | Component parts of the product |
| `OPTIONS` | Optional add-ons |

Each relation points to either a `productTo` (a standalone product) or a `clusterTo` (a cluster), never both. This means cross-sell targets can be individual products or entire product groups with variants.

For example, a desk chair product might have:
- **ACCESSORIES**: four different floor mats (all pointing to standalone products).
- **ALTERNATIVES**: chairs from other brands, including one relation pointing to a cluster with its own variants.
- **RELATED**: other chairs from the same manufacturer.

## How this relates to pricing

Pricing lives on products, not on clusters. Each product has a `priceData` field with the base price configuration:

| Field | Description |
|---|---|
| `list` | The default sales price |
| `store` | The in-store price (can differ from the list price) |
| `suggested` | Manufacturer's recommended retail price |
| `per` | The quantity the listed price applies to |
| `defaultTaxCode` | Tax code: `H` (high), `L` (low) or `N` (none) |
| `bulkPriceDiscountType` | How bulk discounts are applied: as a net price or as a percentage |

On top of the base price, products can have **bulk prices** (tiered pricing based on `quantityFrom`) and **cost prices** (purchase prices, also with `quantityFrom`).

When requesting prices for a specific customer context, use the `price` field which returns calculated prices including `net`, `gross` and any applicable discounts.

For the full pricing model, see [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers).

## How this relates to inventory

Inventory lives on products. The `inventory` field provides:

- `totalQuantity`: the aggregate stock across all warehouses.
- `localQuantity`: stock in local (own) warehouses.
- `supplierQuantity`: stock held by suppliers.
- `nextDeliveryDate`: the earliest expected restocking date.
- `balance[]`: a per-warehouse breakdown, where each entry includes `quantity`, `warehouseId`, `supplier` and `nextDeliveryDate`.

A single product can have stock spread across multiple warehouses and multiple suppliers.

## How this relates to attributes

Attributes are key-value pairs attached to products. Each attribute is defined by an `attributeDescription` that specifies the attribute's `name`, `type`, `group` and behavior flags (`isSearchable`, `isPublic`, `isSystem`, `isHidden`).

Supported attribute types: `TEXT`, `ENUM`, `COLOR`, `DATETIME`, `INT` and `DECIMAL`.

Attributes are organized into groups (e.g. "Kantoormeubilair", "LED verlichting") and can be localized with descriptions and units per language.

In clusters, attributes play a special role: the cluster's config settings reference specific attributes (by name) as the properties that differentiate variants. The attribute values on each product within the cluster then determine which variant is which.

## How this relates to media

Media is attached to products via the `media` field, which contains three paginated sub-fields:

- `images`: product photos with `imageVariants` (named sizes like `small`, `medium`), `alt` text, `description` and `priority` for ordering.
- `videos`: product videos.
- `documents`: downloadable files like PDFs and technical sheets.

Images are served with transformation parameters for resizing and cropping, so you can request the appropriate size for thumbnails, listing pages or detail views.

For practical details, see [Media and assets](/frontend/domain-guides/products-and-catalog/media-and-assets).

## How this relates to bundles

Products can be part of bundles. A bundle groups multiple products together and sells them at a combined price, typically with a discount compared to buying each item individually.

Each bundle has:

| Field | Description |
|---|---|
| `id` | Unique bundle identifier |
| `name` | Bundle name |
| `discount` | Discount applied to the bundle |
| `condition` | Rules for when the bundle applies |
| `price` | Combined bundle price (gross, net, original prices) |
| `items` | The products included in the bundle |

One product in a bundle is the **leader** (marked with `isLeader`). The leader is the main product that the bundle is displayed on. The other items are complementary products included in the bundle offer.

Bundles are returned as a list on the product via the `bundles` field. For adding bundles to a cart, see [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management).

---

## Frontend Patterns

URL: https://docs.propeller-commerce.com/frontend/frontend-patterns

# Frontend Patterns

Patterns that apply when building on Propeller's GraphQL API, regardless of your framework choice.

- [Public vs authenticated data](/frontend/frontend-patterns/public-vs-authenticated-data) — which data changes based on authentication state and how that affects your architecture

---

## Public vs Authenticated Data

URL: https://docs.propeller-commerce.com/frontend/frontend-patterns/public-vs-authenticated-data

# Public vs authenticated data

Propeller's GraphQL API returns different data depending on whether the request includes an authenticated session. Understanding which data is public and which is session-dependent helps you decide what to cache, pre-render or fetch per request.

## Public data

Public data is the same for every visitor, whether anonymous or logged in. This includes:

- **Product catalog**: names, descriptions, SKUs, attributes and media
- **Categories**: the full category tree and navigation structure
- **Default prices**: the list price (`priceData.list`) and suggested price (`priceData.suggested`)
- **Product search and filtering**: search results when not restricted by orderlists

This data is safe to cache, statically generate or serve from a CDN. It does not depend on who is viewing it.

## Session-dependent data

Session-dependent data changes based on the authenticated user. This data must be fetched per request with the user's session context.

### Prices

Authenticated users who belong to a company with a price sheet see different prices than anonymous users. The `price` field automatically reflects the applicable price sheet when queried with an authenticated session. The `price.type` field tells you where the price came from:

- `DEFAULT` for anonymous users or users without a price sheet (the list price)
- `PRICESHEET` for users with customer-specific pricing

Anonymous users always see the list price. See [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) for details.

### Product visibility

In B2B, orderlists control which products are visible and orderable for a specific company. When you query products with `applyOrderlists: true`, only products assigned to the company's orderlists are returned. Anonymous users without orderlist filtering see the full catalog. See [Querying products](/frontend/domain-guides/products-and-catalog/querying-products#filtering-by-orderlist) for how to apply orderlist filtering.

### Cart

Carts belong to the current session. An anonymous session has its own cart. When a user logs in, the cart is associated with their account. Cart data is always session-scoped and cannot be cached across users. See [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) for details.

### Favorite lists

Favorite lists belong to a contact, customer or company. They are only accessible when authenticated. See [Favorite lists](/frontend/domain-guides/accounts-and-authentication/favorite-lists) for how favorite list ownership works.

### Order history

Orders are only visible to authenticated users. In B2B, orders can be filtered by company so that a procurement manager sees all orders placed by any contact in the company. See [Order history](/frontend/domain-guides/orders-and-shipments/order-history) for listing and filtering orders.

### Account data

The `viewer` query returns the current user's identity. For authenticated users, it returns a `Contact` (B2B) or `Customer` (B2C) with their profile data. For anonymous users, the response indicates that no user is logged in.

## Detecting authentication state

Use the `viewer` query to determine whether the current session is authenticated:

```graphql
query {
  viewer {
    __typename
    isLoggedIn
  }
}
```

When `isLoggedIn` is `true`, the user has an active session and you can fetch session-dependent data. The `__typename` field returns `Contact` for B2B users or `Customer` for B2C users, which determines what account features to show.

See [Authentication and authorization](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization#the-viewer-query) for the full viewer query and response examples.

## Practical implications

**Catalog pages** can be built with public data for fast initial loads. Product names, descriptions, images, categories and default prices are all public. Cache or pre-render these freely.

**Personalized data** (customer-specific prices, orderlist-filtered products) should be loaded once the user's session is known. A common approach is to render the catalog page with list prices first, then replace them with the customer's prices after authentication is confirmed.

**"Log in for your price"** is a pattern used in B2B storefronts where prices vary significantly between customers. Check `price.type`: when it returns `DEFAULT`, the visitor is seeing the list price. When it returns `PRICESHEET`, they are seeing their negotiated price. Some B2B storefronts hide prices entirely for anonymous visitors and show a login prompt instead.

**Cart and account pages** always require session context. There is no public fallback for these.

## Next steps

- [Authentication and authorization](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization) for login, tokens and the viewer query
- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) for how price sheets work
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products#filtering-by-orderlist) for orderlist filtering
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) for cart session behavior

---

## Frontend Guides

URL: https://docs.propeller-commerce.com/frontend

# Frontend Development Guides

Guides for partners building customer-facing experiences on Propeller. All content in this section uses the **GraphQL API**.

Each topic starts with a concept explanation so you understand how Propeller handles the domain, followed by practical how-to guides with code examples.

## Frontend patterns

Patterns that apply when building on Propeller's GraphQL API, regardless of your framework choice.

- [Public vs authenticated data](/frontend/frontend-patterns/public-vs-authenticated-data) — which data changes based on authentication state and how that affects your architecture

## Products and catalog

Understand Propeller's product model (clusters, products, variants and attributes) and learn how to query, filter and display product data.

- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) — products and variants (clusters)
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) — filtering, pagination and search
- [Product detail queries](/frontend/domain-guides/products-and-catalog/product-detail-queries) — attributes, cross-sell relations and bundles
- [Categories and navigation](/frontend/domain-guides/products-and-catalog/categories-and-navigation) — category tree, breadcrumbs and navigation menus
- [Media and assets](/frontend/domain-guides/products-and-catalog/media-and-assets) — images with transformations, videos and documents

## Accounts and authentication

Account management for B2B and B2C: customers, contacts, companies, authentication and address management.

- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) — B2B and B2C account entities
- [Authentication and authorization](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization) — registration, login, tokens and session management
- [Managing addresses](/frontend/domain-guides/accounts-and-authentication/managing-addresses) — address CRUD for customers and companies
- [Favorite lists](/frontend/domain-guides/accounts-and-authentication/favorite-lists) — save products for quick access and reordering

## Pricing and discounts

How Propeller's pricing layers work, including customer-specific pricing, tiered pricing and promotions.

- [Understanding pricing layers](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers) — price types, tax zones and surcharges
- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) — price sheets, action codes and custom overrides
- [Tiered and volume pricing](/frontend/domain-guides/pricing-and-discounts/tiered-and-volume-pricing) — bulk discounts and quantity breaks

## Cart and checkout

The full order lifecycle from cart management through checkout and payment integration.

- [Understanding the order lifecycle](/frontend/domain-guides/cart-and-checkout/understanding-the-order-lifecycle) — how cart, order and fulfillment relate
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — create carts, add items, manage state and persistence
- [Checkout flow](/frontend/domain-guides/cart-and-checkout/checkout-flow) — addresses, shipping, payment and order creation
- [Payment integration](/frontend/domain-guides/cart-and-checkout/payment-integration) — PSP integration, payment tracking and order confirmation

## Orders and shipments

Order history, shipment tracking and reordering for the customer portal.

- [Order history](/frontend/domain-guides/orders-and-shipments/order-history) — list, filter and view order details
- [Shipment tracking](/frontend/domain-guides/orders-and-shipments/shipment-tracking) — display shipping information and tracking codes
- [Reordering](/frontend/domain-guides/orders-and-shipments/reordering) — let customers reorder from previous orders

## Storefront SDK

The Storefront SDK provides typed services, pre-built UI components and an optional Accelerator app for building customer-facing experiences. These guides cover what is specific to the SDK and build on top of the domain guides above.

- [Understanding the Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk) — three-layer architecture and how the pieces fit together
- [Choosing Your Approach](/frontend/storefront-sdk/choosing-your-approach) — common partner architectures and a decision table
- [SDK Services](/frontend/storefront-sdk/sdk-services) — typed TypeScript services for products, categories, carts, users and orders
- [UI Components](/frontend/storefront-sdk/ui-components) — pre-built components, callbacks and stack-agnostic documentation
- [Accelerator](/frontend/storefront-sdk/accelerator) — complete working storefront app with routing, CMS integration and state management
- [CMS Integration](/frontend/storefront-sdk/cms-integration) — adapter pattern, bridge blocks and dynamic block rendering
- [Routing](/frontend/storefront-sdk/routing) — commerce routes, CMS routes and URL configuration
- [Customization](/frontend/storefront-sdk/customization) — callbacks, pass-through properties and override patterns
- [B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities) — portal modes, contact-company model and clusters

## WordPress Plugin

In-depth guides for configuring and customizing the Propeller WordPress Plugin. Covers every admin tab, portal mode, multi-site and developer customization.

- [Understanding the plugin](/frontend/wordpress-plugin/understanding-the-plugin) — how the plugin works under the hood
- [General settings](/frontend/wordpress-plugin/general-settings) — API connection, channel, language, currency and portal mode
- [Pages and shortcodes](/frontend/wordpress-plugin/pages-and-shortcodes) — page slugs, shortcodes and custom pages
- [Behavior and display](/frontend/wordpress-plugin/behavior-and-display) — feature toggles and display options
- [Translations and valuesets](/frontend/wordpress-plugin/translations-and-valuesets) — UI labels and predefined value lists
- [Sitemaps](/frontend/wordpress-plugin/sitemaps) — XML sitemap generation from Propeller data
- [Multi-site setup](/frontend/wordpress-plugin/multi-site-setup) — running the plugin across a WordPress Multisite network

---

## Add a product to cart

URL: https://docs.propeller-commerce.com/frontend/recipes/add-product-to-cart

# Add a product to cart

Add an item to a cart and get the updated totals.

## Mutation

```graphql
mutation AddToCart($cartId: String!, $productId: Int!, $quantity: Int!) {
  cartAddItem(
    id: $cartId
    input: { productId: $productId, quantity: $quantity }
  ) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    total {
      totalGross
      totalNet
    }
  }
}
```

## Variables

```json
{
  "cartId": "018dcc9a-f965-7434-8fad-369aa9a8c276",
  "productId": 67890,
  "quantity": 2
}
```

## Response

```json
{
  "data": {
    "cartAddItem": {
      "items": [
        {
          "itemId": "a1b2c3",
          "productId": 67890,
          "quantity": 2,
          "price": 15.00,
          "priceNet": 18.15,
          "totalPrice": 30.00,
          "totalPriceNet": 36.30
        }
      ],
      "total": {
        "totalGross": 30.00,
        "totalNet": 36.30
      }
    }
  }
}
```

## How it works

`cartAddItem` adds the product or increases its quantity if it already exists in the cart. The response returns all cart items with updated totals, so you can refresh the UI in one round trip. Note the price field naming: `price` and `totalPrice` are gross (excluding tax), while `priceNet` and `totalPriceNet` are net (including tax) — the opposite of what you might expect. Products may have a `minimumQuantity` or `purchaseUnit` constraint; the API rejects quantities that violate these.

## See also

- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — full cart lifecycle guide

---

## Add product video

URL: https://docs.propeller-commerce.com/frontend/recipes/add-product-video

# Add product video

Attach a video to a product, cluster or category using the GraphQL API.

## Mutation

```graphql
mutation CreateMediaVideo($input: MediaVideoInput!) {
  mediaVideoCreate(input: $input) {
    id
    productId
    alt { language value }
    description { language value }
    priority
    createdAt
  }
}
```

## Variables

```json
{
  "input": {
    "productId": "26",
    "alt": [
      { "language": "NL", "value": "Industriële Kachel HT-350 installatiehandleiding" }
    ],
    "description": [
      { "language": "NL", "value": "Stapsgewijze installatievideo" }
    ],
    "tags": [
      { "language": "NL", "values": ["installatie", "handleiding"] }
    ],
    "priority": 1,
    "videos": [
      {
        "language": "NL",
        "uri": "https://www.youtube.com/watch?v=abc123xyz"
      }
    ]
  }
}
```

## Response

```json
{
  "data": {
    "mediaVideoCreate": {
      "id": "66d7bc7f690599fecc3fa6b3",
      "productId": "26",
      "alt": [{ "language": "NL", "value": "Industriële Kachel HT-350 installatiehandleiding" }],
      "description": [{ "language": "NL", "value": "Stapsgewijze installatievideo" }],
      "priority": 1,
      "createdAt": "2026-03-05T10:30:00.000Z"
    }
  }
}
```

## Attaching to other entities

Replace `productId` with the appropriate field to attach media to other entities:

| Field | Entity |
|-------|--------|
| `productId` | Product |
| `clusterId` | Cluster |
| `categoryId` | Category |

## How it works

The `videos` array accepts one or more video entries, each with a `language` and a `uri`. The URI can be a YouTube or Vimeo link. The `priority` field controls display order (lower numbers appear first). Use `alt` for accessibility text and `description` for longer captions.

## See also

- [Upload product images](/frontend/recipes/upload-product-images) — attach images to a product
- [Fetch product videos](/frontend/recipes/fetch-product-videos) — retrieve videos for product detail pages

---

## Add products to order list

URL: https://docs.propeller-commerce.com/frontend/recipes/add-products-to-order-list

# Add products to order list

Add products to an existing order list. The mutation returns the updated list with all products.

## Mutation

```graphql
mutation AddItemsToOrderlist($id: Int!, $input: OrderlistItemsInput!) {
  orderlistAddItems(id: $id, input: $input) {
    id
    products(input: { offset: 100, page: 1 }) {
      items {
        ... on Product {
          productId
          names(language: "NL") { value }
        }
      }
      itemsFound
    }
  }
}
```

## Variables

```json
{
  "id": 230,
  "input": {
    "productIds": [31, 2151]
  }
}
```

## Response

```json
{
  "data": {
    "orderlistAddItems": {
      "id": 230,
      "products": {
        "items": [
          { "productId": 25, "names": [{ "value": "Industriële Kachel HT-1001" }] },
          { "productId": 26, "names": [{ "value": "Industriële Kachel HT-350" }] },
          { "productId": 28, "names": [{ "value": "Vuurvaste Bodemplaat HT-425" }] },
          { "productId": 31, "names": [{ "value": "Hitteschild Links HT-101" }] },
          { "productId": 2151, "names": [{ "value": "LED Paneel Backlit 60x60 3000K" }] }
        ],
        "itemsFound": 5
      }
    }
  }
}
```

## How it works

Pass the order list `id` and a list of `productIds` to add. The response includes the full product list so you can verify the update. Products can also be referenced by external source using `productSources` instead of `productIds`.

## See also

- [Create an order list](/frontend/recipes/create-an-order-list) — create a new order list with initial products
- [Assign users to order list](/frontend/recipes/assign-users-to-order-list) — assign contacts to a list

---

## Apply a discount code to the cart

URL: https://docs.propeller-commerce.com/frontend/recipes/apply-discount-code

# Apply a discount code to the cart

Add an action code (discount code) to the cart and get the updated totals with the discount applied.

## Mutation

```graphql
mutation ApplyActionCode($cartId: String!, $actionCode: String!) {
  cartAddActionCode(
    id: $cartId
    input: { actionCode: $actionCode }
  ) {
    actionCode
    total {
      subTotal
      totalGross
      totalNet
      discount
      discountNet
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728",
  "actionCode": "SUMMER20"
}
```

## Response

```json
{
  "data": {
    "cartAddActionCode": {
      "actionCode": "SUMMER20",
      "total": {
        "subTotal": 4785.12,
        "totalGross": 5120.12,
        "totalNet": 6195.34,
        "discount": 957.02,
        "discountNet": 1157.99
      }
    }
  }
}
```

## How it works

The `actionCode` goes inside the `input` object. If the code is invalid or cannot be applied, the mutation returns an error — check for `CART_ACTION_CODE_ADD_ERROR` in the response extensions. The `actionCode` field on the cart is only populated when a valid code is active. The `discount` and `discountNet` fields on the total reflect the reduction. To remove an applied code, use the `cartDeleteActionCode` mutation.

## See also

- [Fetch cart with totals and tax breakdown](/frontend/recipes/fetch-cart-with-totals)

---

## Assign users to order list

URL: https://docs.propeller-commerce.com/frontend/recipes/assign-users-to-order-list

# Assign users to order list

Assign contacts to an order list so the list's product restrictions apply to them.

## Mutation

```graphql
mutation AssignUsersToOrderlist($id: Int!, $input: OrderlistUsersInput!) {
  orderlistAssignUsers(id: $id, input: $input) {
    id
    usersPaginated(input: { offset: 50, page: 1 }) {
      items {
        ... on Contact {
          contactId
          firstName
          lastName
        }
      }
      itemsFound
    }
  }
}
```

## Variables

```json
{
  "id": 230,
  "input": {
    "userIds": [312, 42]
  }
}
```

## Response

```json
{
  "data": {
    "orderlistAssignUsers": {
      "id": 230,
      "usersPaginated": {
        "items": [
          { "contactId": 312, "firstName": "Lisa", "lastName": "de Vries" },
          { "contactId": 42, "firstName": "Tom", "lastName": "Hendriks" }
        ],
        "itemsFound": 2
      }
    }
  }
}
```

## How it works

Pass the order list `id` and a list of `userIds` (contact IDs) to assign. The response includes the full user list so you can verify the assignment. To assign at the company level instead of individual contacts, use `orderlistAssignCompanies` with `companyIds`.

## See also

- [Create an order list](/frontend/recipes/create-an-order-list) — create a new order list
- [Add products to order list](/frontend/recipes/add-products-to-order-list) — add products to a list
- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) — user types that can be assigned to lists

---

## Build a category navigation tree

URL: https://docs.propeller-commerce.com/frontend/recipes/build-category-navigation-tree

# Build a category navigation tree

Query the full category hierarchy and render it as a nested menu with slugs for routing.

## Query

```graphql
query GetCategories($language: String) {
  categories {
    items {
      ... on Category {
        categoryId
        name(language: $language) {
          value
        }
        slug(language: $language) {
          value
        }
        parent {
          categoryId
        }
        categoryPath {
          categoryId
          name(language: $language) {
            value
          }
          slug(language: $language) {
            value
          }
        }
      }
    }
    itemsFound
  }
}
```

## Variables

```json
{
  "language": "EN"
}
```

## Response

```json
{
  "data": {
    "categories": {
      "items": [
        {
          "categoryId": 1794,
          "name": [{ "value": "ICT and hardware" }],
          "slug": [{ "value": "ict-and-hardware" }],
          "parent": null,
          "categoryPath": []
        },
        {
          "categoryId": 1795,
          "name": [{ "value": "Computers / laptops" }],
          "slug": [{ "value": "computers-laptops" }],
          "parent": { "categoryId": 1794 },
          "categoryPath": [
            { "categoryId": 1794, "name": [{ "value": "ICT and hardware" }], "slug": [{ "value": "ict-and-hardware" }] }
          ]
        },
        {
          "categoryId": 1796,
          "name": [{ "value": "Business laptops" }],
          "slug": [{ "value": "business-laptops" }],
          "parent": { "categoryId": 1795 },
          "categoryPath": [
            { "categoryId": 1794, "name": [{ "value": "ICT and hardware" }], "slug": [{ "value": "ict-and-hardware" }] },
            { "categoryId": 1795, "name": [{ "value": "Computers / laptops" }], "slug": [{ "value": "computers-laptops" }] }
          ]
        }
      ],
      "itemsFound": 3
    }
  }
}
```

## How it works

The response is a flat list of all categories. Each item has a `parent.categoryId` that tells you where it sits in the hierarchy — root categories have `parent: null`. Build a tree on the client by grouping items by their parent. Use `slug` values for URL routing and `categoryPath` for rendering breadcrumbs on category pages.

## See also

- [Categories and navigation](/frontend/domain-guides/products-and-catalog/categories-and-navigation) — full guide on category queries and breadcrumbs

---

## Convert a quote into an order

URL: https://docs.propeller-commerce.com/frontend/recipes/convert-quote-to-order

# Convert a quote into an order

Accept a quote and turn it into a confirmed order that can be fulfilled.

## Mutation

```graphql
mutation ConvertQuoteToOrder($orderId: Int!, $status: String!) {
  orderSetStatus(
    input: {
      orderId: $orderId
      status: $status
    }
  ) {
    id
    status
    type
    createdAt
    total {
      gross
      net
    }
  }
}
```

## Variables

```json
{
  "orderId": 2792,
  "status": "CONFIRMED"
}
```

## Response

```json
{
  "data": {
    "orderSetStatus": {
      "id": 2792,
      "status": "CONFIRMED",
      "type": "quotation",
      "createdAt": "2026-02-12T14:22:08.000Z",
      "total": {
        "gross": 917.23,
        "net": 917.23
      }
    }
  }
}
```

## How it works

Use `orderSetStatus` to transition a quote (`type: quotation`, `status: QUOTATION`) to a confirmed order (`status: CONFIRMED`). Quotes can originate from a customer's quote request or be created directly by a sales rep — either way, the customer confirms from the portal using this mutation. This is typically triggered from a "Convert to order" button on the quote detail page. The order ID stays the same after the transition. The available status transitions depend on the order status set configured in your Propeller environment.

## See also

- [Fetch quote or order detail](/frontend/recipes/fetch-order-detail)
- [Fetch quote list](/frontend/recipes/fetch-quote-list)
- [Submit a quote request from the cart](/frontend/recipes/submit-quote-request-from-cart)

---

## Create a channel

URL: https://docs.propeller-commerce.com/frontend/recipes/create-a-channel

# Create a channel

Add a new channel to the platform. A channel represents a separate storefront or sales context (e.g. a B2B portal, a regional shop).

## Mutation

```graphql
mutation CreateChannel($input: ChannelCreateInput!) {
  channelCreate(input: $input) {
    channelId
    name
    catalogRootId
    anonymousUserId
  }
}
```

## Variables

```json
{
  "input": {
    "name": "Dealer Portal DE",
    "descriptions": [
      { "language": "EN", "value": "German dealer portal" },
      { "language": "NL", "value": "Duits dealerportaal" }
    ],
    "catalogRootId": 2050,
    "anonymousUserId": 14551
  }
}
```

## Response

```json
{
  "data": {
    "channelCreate": {
      "channelId": 72,
      "name": "Dealer Portal DE",
      "catalogRootId": 2050,
      "anonymousUserId": 14551
    }
  }
}
```

## How it works

Only the `name` field is required. Use `catalogRootId` to control which part of the category tree is visible on the channel. The `anonymousUserId` sets the default user context for unauthenticated visitors, controlling which prices and product visibility rules apply. Use `descriptions` to provide localized display names.

## See also

- [List channels](/frontend/recipes/list-channels) — retrieve all configured channels
- [Update a channel](/frontend/recipes/update-a-channel) — modify an existing channel
- [Delete a channel](/frontend/recipes/delete-a-channel) — remove a channel

---

## Create an order list

URL: https://docs.propeller-commerce.com/frontend/recipes/create-an-order-list

# Create an order list

Create an order list to control which products specific users or companies can (or cannot) order.

## Mutation

```graphql
mutation CreateOrderlist($input: OrderlistCreateInput!) {
  orderlistCreate(input: $input) {
    id
    type
    active
    code
    descriptions { language value }
    validFrom
    validTo
  }
}
```

## Variables

```json
{
  "input": {
    "type": "POSITIVE",
    "descriptions": [
      { "language": "EN", "value": "Approved industrial heating products" },
      { "language": "NL", "value": "Goedgekeurde industriële verwarmingsproducten" }
    ],
    "code": "HEAT-APPROVED-2026",
    "productIds": [25, 26, 28],
    "active": "Y"
  }
}
```

## Response

```json
{
  "data": {
    "orderlistCreate": {
      "id": 230,
      "type": "POSITIVE",
      "active": "Y",
      "code": "HEAT-APPROVED-2026",
      "descriptions": [
        { "language": "EN", "value": "Approved industrial heating products" },
        { "language": "NL", "value": "Goedgekeurde industriële verwarmingsproducten" }
      ],
      "validFrom": null,
      "validTo": null
    }
  }
}
```

## List types

| Type | Behavior |
|------|----------|
| `POSITIVE` | Assigned users/companies can **only** see and order products on this list. All other products are hidden. |
| `NEGATIVE` | Assigned users/companies **cannot** see or order products on this list. All other products remain available. |

## How it works

Order lists are a B2B access control mechanism. A `POSITIVE` list restricts a user's catalog to a curated set of approved products, while a `NEGATIVE` list hides specific products (e.g. hazardous materials, competitor brands). Products can be referenced by ID (`productIds`) or by external source (`productSources`). Use `validFrom` and `validTo` to make lists time-bound. Use `companyIds` or `userIds` on creation to assign the list immediately, or use the separate assign mutations afterward.

## See also

- [Add products to order list](/frontend/recipes/add-products-to-order-list) — add more products to an existing list
- [Assign users to order list](/frontend/recipes/assign-users-to-order-list) — assign contacts to a list
- [Query products with customer-specific pricing](/frontend/recipes/query-products-with-customer-pricing) — order lists can also carry customer-specific pricing

---

## Create cross-sell and upsell relations

URL: https://docs.propeller-commerce.com/frontend/recipes/create-cross-sell-and-upsell-relations

# Create cross-sell and upsell relations

Link two products or clusters as related, accessories, parts, alternatives or options.

## Mutation

```graphql
mutation CreateCrossupsell($input: CrossupsellCreateInput!) {
  crossupsellCreate(input: $input) {
    id
    type
    subType
    productFrom {
      ... on Product {
        productId
        names(language: "NL") { value }
      }
    }
    productTo {
      ... on Product {
        productId
        names(language: "NL") { value }
      }
    }
    createdAt
  }
}
```

## Variables

```json
{
  "input": {
    "type": "ACCESSORIES",
    "productIdFrom": 25,
    "productIdTo": 31
  }
}
```

## Response

```json
{
  "data": {
    "crossupsellCreate": {
      "id": "a1b2c3d4e5f6",
      "type": "ACCESSORIES",
      "subType": null,
      "productFrom": {
        "productId": 25,
        "names": [{ "value": "Industriële Kachel HT-1001" }]
      },
      "productTo": {
        "productId": 31,
        "names": [{ "value": "Hitteschild Links HT-101" }]
      },
      "createdAt": "2026-03-05T10:00:00.000Z"
    }
  }
}
```

## Linking clusters

To link clusters instead of individual products, use `clusterIdFrom` and `clusterIdTo`:

```json
{
  "input": {
    "type": "RELATED",
    "clusterIdFrom": 100,
    "clusterIdTo": 200
  }
}
```

You can also mix products and clusters (e.g. `productIdFrom` with `clusterIdTo`).

## Available relation types

| Type | Use case |
|------|----------|
| `RELATED` | General "you might also like" recommendations |
| `ACCESSORIES` | Add-on items that complement the main product |
| `PARTS` | Replacement or spare parts for the main product |
| `ALTERNATIVES` | Similar products the buyer could choose instead |
| `OPTIONS` | Configurable options or upgrades |

Use the optional `subType` string field to further classify relations within a type (e.g. `"subType": "mounting-kit"`).

## How it works

The relation is directional: `productIdFrom` is the source product and `productIdTo` is the target. To create a bidirectional relation, create two crossupsell records with the IDs swapped. On the storefront side, use `crossupsellsFrom` on the product query to fetch outgoing relations.

## See also

- [Display cross-sell and upsell products](/frontend/recipes/display-cross-sell-and-upsell-products) — query and render related products on a product detail page

---

## Create inventory

URL: https://docs.propeller-commerce.com/frontend/recipes/create-inventory

# Create inventory

Add a stock record for a product in a warehouse or at a supplier.

## Mutation

```graphql
mutation CreateInventory($input: CreateInventoryInput!) {
  inventoryCreate(input: $input) {
    id
    productId
    quantity
    warehouseId
    location
    supplier
    costPrice
    nextDeliveryDate
    notes
    total
    warehouse {
      id
      name
    }
  }
}
```

## Variables

```json
{
  "input": {
    "type": "local",
    "productId": 26,
    "quantity": 500,
    "warehouseId": 1,
    "location": "AISLE-4-SHELF-B",
    "notes": "Initial stock import from ERP",
    "costPrice": 12.50,
    "nextDeliveryDate": "2026-04-01T00:00:00.000Z"
  }
}
```

## Response

```json
{
  "data": {
    "inventoryCreate": {
      "id": "98422",
      "productId": 26,
      "quantity": 500,
      "warehouseId": 1,
      "location": "AISLE-4-SHELF-B",
      "supplier": "INTERN",
      "costPrice": 12.50,
      "nextDeliveryDate": "2026-04-01T00:00:00.000Z",
      "notes": "Initial stock import from ERP",
      "total": 500,
      "warehouse": {
        "id": 1,
        "name": "Main Warehouse"
      }
    }
  }
}
```

### Supplier inventory

Use `type: "supplier"` to record stock held by a supplier rather than in a warehouse. The `supplier` field defaults to the product's supplier if not provided.

```json
{
  "input": {
    "type": "supplier",
    "productId": 26,
    "quantity": 2000,
    "supplier": "Ingram Micro",
    "nextDeliveryDate": "2026-03-15T00:00:00.000Z",
    "notes": "Supplier confirmed availability"
  }
}
```

## Inventory types

| Type | Behavior |
|------|----------|
| `local` | Stock in a warehouse. Defaults supplier to `INTERN`. |
| `supplier` | Stock held by an external supplier. Defaults supplier to the product's supplier field. |

## How it works

Each inventory record represents a stock quantity for one product in one warehouse (or at one supplier). A product can have multiple inventory records across different warehouses. The `total` field in the response sums up all inventory for that product. Use `location` to specify a bin or shelf position within a warehouse. The `nextDeliveryDate` field is informational and shown to buyers when a product is out of stock.

## See also

- [Delete inventory](/frontend/recipes/delete-inventory) — remove an inventory record
- [Fetch product stock across warehouses](/frontend/recipes/fetch-product-stock) — query inventory from the storefront

---

## Create sales tickets

URL: https://docs.propeller-commerce.com/frontend/recipes/create-sales-tickets

# Create sales tickets

Create actionable tickets for sales reps in the Sales Hub. Tickets flag situations that need attention, such as inactive accounts, product recommendations or new registrations.

## Mutation

```graphql
mutation CreateTicket($input: TicketCreateInput!) {
  ticketCreate(input: $input) {
    id
    titles { language value }
    descriptions { language value }
    type
    status
    companyId
    contactId
    productId
    orderId
    assignedToAdminUserId
    createdAt
  }
}
```

### Variables

```json
{
  "input": {
    "titles": [
      { "language": "NL", "value": "Inactief account: Brouwer Industrie" }
    ],
    "descriptions": [
      { "language": "NL", "value": "Geen bestellingen in de afgelopen 90 dagen. Gemiddelde was 2 bestellingen per maand." }
    ],
    "type": "CHURN_RISK",
    "status": "OPEN",
    "companyId": 456,
    "assignedToAdminUserId": 10
  }
}
```

### Response

```json
{
  "data": {
    "ticketCreate": {
      "id": "01JNQXYZ1234567890AB",
      "titles": [{ "language": "NL", "value": "Inactief account: Brouwer Industrie" }],
      "descriptions": [{ "language": "NL", "value": "Geen bestellingen in de afgelopen 90 dagen. Gemiddelde was 2 bestellingen per maand." }],
      "type": "CHURN_RISK",
      "status": "OPEN",
      "companyId": 456,
      "contactId": null,
      "productId": null,
      "orderId": null,
      "assignedToAdminUserId": 10,
      "createdAt": "2026-03-05T10:00:00.000Z"
    }
  }
}
```

### More input examples

Link a ticket to a specific product and contact:

```json
{
  "input": {
    "titles": [
      { "language": "NL", "value": "Productaanbeveling voor Brouwer Industrie" }
    ],
    "descriptions": [
      { "language": "NL", "value": "Klant heeft product #25 drie keer besteld maar nog niet het aanvullende item #31." }
    ],
    "type": "CROSS_SELL",
    "status": "OPEN",
    "companyId": 456,
    "contactId": 312,
    "productId": 31
  }
}
```

Link a ticket to an order:

```json
{
  "input": {
    "titles": [
      { "language": "NL", "value": "Opvolging recente grote bestelling" }
    ],
    "descriptions": [
      { "language": "NL", "value": "Bestelling #2791 was aanzienlijk groter dan gemiddeld. Controleer of de klant extra ondersteuning nodig heeft." }
    ],
    "type": "FOLLOW_UP",
    "status": "OPEN",
    "companyId": 456,
    "orderId": 2791
  }
}
```

## Ticket statuses

| Status | Meaning |
|--------|---------|
| `OPEN` | New ticket, not yet picked up |
| `IN_PROGRESS` | Sales rep is working on it |
| `COMPLETED` | Action taken, ticket resolved |
| `ARCHIVED` | No longer relevant |

## How it works

Tickets link a sales action to the relevant entities: a company, contact, product, order or cluster. The `assignedToAdminUserId` routes the ticket to a specific sales rep. The `type` field is a free-form string, so you can use any value that fits your workflow. The `status` field uses the `TicketStatus` enum (`OPEN`, `IN_PROGRESS`, `COMPLETED`, `ARCHIVED`). Use `externalUrl` to link to an external CRM or dashboard for additional context. Tickets can be created manually by a sales rep or automatically by an integration that analyzes order patterns.

## See also

- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) — the entities tickets can reference

---

## Delete a channel

URL: https://docs.propeller-commerce.com/frontend/recipes/delete-a-channel

# Delete a channel

Remove a channel from the platform.

## Mutation

```graphql
mutation DeleteChannel($id: Int!) {
  channelDelete(id: $id)
}
```

## Variables

```json
{
  "id": 72
}
```

## Response

```json
{
  "data": {
    "channelDelete": true
  }
}
```

## How it works

The mutation returns `true` when the channel is successfully deleted. Deleting a channel does not remove the products or categories associated with it. The catalog root and its contents remain available for other channels.

## See also

- [List channels](/frontend/recipes/list-channels) — retrieve all configured channels
- [Create a channel](/frontend/recipes/create-a-channel) — add a new channel

---

## Delete inventory

URL: https://docs.propeller-commerce.com/frontend/recipes/delete-inventory

# Delete inventory

Remove an inventory record for a product.

## Mutation

```graphql
mutation DeleteInventory($id: Int!) {
  inventoryDelete(id: $id) {
    messages
  }
}
```

## Variables

```json
{
  "id": 98422
}
```

## Response

```json
{
  "data": {
    "inventoryDelete": {
      "messages": []
    }
  }
}
```

## How it works

Pass the inventory record `id` (not the product ID) to delete a specific stock entry. An empty `messages` array indicates success. Deleting an inventory record does not affect other inventory records for the same product in different warehouses.

## See also

- [Create inventory](/frontend/recipes/create-inventory) — add a stock record
- [Fetch product stock across warehouses](/frontend/recipes/fetch-product-stock) — query inventory from the storefront

---

## Display cross-sell and upsell products

URL: https://docs.propeller-commerce.com/frontend/recipes/display-cross-sell-and-upsell-products

# Display cross-sell and upsell products

Fetch related products and clusters linked to the current product for a "You might also need" section.

## Query

```graphql
query GetCrossUpsell($productId: Int!, $language: String) {
  product(productId: $productId) {
    crossupsellsFrom(input: { offset: 12, page: 1 }) {
      items {
        type
        productTo {
          ... on Product {
            productId
            names(language: $language) {
              value
            }
            price {
              gross
              net
            }
            media {
              images(search: { sort: ASC, offset: 1 }) {
                items {
                  imageVariants(
                    input: {
                      transformations: {
                        name: "thumb"
                        transformation: {
                          width: 200
                          height: 200
                          fit: BOUNDS
                          format: WEBP
                        }
                      }
                    }
                  ) {
                    url
                  }
                }
              }
            }
          }
          ... on Cluster {
            clusterId
            names(language: $language) {
              value
            }
            defaultProduct {
              productId
              price {
                gross
                net
              }
            }
          }
        }
      }
      itemsFound
    }
  }
}
```

## Variables

```json
{
  "productId": 123,
  "language": "EN"
}
```

## Response

```json
{
  "data": {
    "product": {
      "crossupsellsFrom": {
        "items": [
          {
            "type": "RELATED",
            "productTo": {
              "productId": 26,
              "names": [{ "value": "Dovre Rock350 TB" }],
              "price": { "gross": 2275.21, "net": 2753.00 }
            }
          },
          {
            "type": "ACCESSORIES",
            "productTo": {
              "productId": 31,
              "names": [{ "value": "Dovre Saga 101 heat shield left" }],
              "price": { "gross": 70.00, "net": 84.70 }
            }
          },
          {
            "type": "PARTS",
            "productTo": {
              "productId": 28,
              "names": [{ "value": "Dovre 425CB fire bed" }],
              "price": { "gross": 172.44, "net": 208.65 }
            }
          }
        ],
        "itemsFound": 12
      }
    }
  }
}
```

## How it works

Each item has a `type` field describing the relationship: `RELATED`, `ACCESSORIES`, `PARTS`, or `OPTIONS`. Use `crossupsellsFrom` to get products linked from the current product, or `crossupsellsTo` for the reverse direction. The `productTo` field is a union — it can be a `Product` or `Cluster`, so use inline fragments to access type-specific fields.

## See also

- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) — how clusters and products relate

---

## Display tiered and bulk pricing

URL: https://docs.propeller-commerce.com/frontend/recipes/display-tiered-and-bulk-pricing

# Display tiered and bulk pricing

Show quantity breaks and volume discounts on a product detail page so the buyer sees how the unit price drops.

## Query

```graphql
query GetBulkPrices($productId: Int!, $taxZone: String) {
  product(productId: $productId) {
    ... on Product {
      price(input: { taxZone: $taxZone }) {
        gross
        net
      }
      priceData {
        bulkPriceDiscountType
      }
      bulkPrices {
        gross
        net
        list
        quantity
      }
    }
  }
}
```

## Variables

```json
{
  "productId": 123,
  "taxZone": "NL"
}
```

## Response

```json
{
  "data": {
    "product": {
      "price": { "gross": 10.00, "net": 12.10 },
      "priceData": { "bulkPriceDiscountType": "NET_PRICE" },
      "bulkPrices": [
        { "gross": 10.00, "net": 12.10, "list": 10.00, "quantity": 1 },
        { "gross": 8.50, "net": 10.29, "list": 10.00, "quantity": 10 },
        { "gross": 7.00, "net": 8.47, "list": 10.00, "quantity": 50 }
      ]
    }
  }
}
```

## How it works

Each entry in `bulkPrices` represents the unit price at a quantity threshold. The `quantity` field is the minimum quantity for that tier — the tier applies from that quantity up to the next tier's `quantity - 1`. The `bulkPriceDiscountType` determines how tiers work: `NET_PRICE` means each tier's `gross`/`net` is the absolute unit price, while `PERCENTAGE` means the value is a discount off the base price. The `list` field always shows the original list price for reference.

## See also

- [Tiered and volume pricing](/frontend/domain-guides/pricing-and-discounts/tiered-and-volume-pricing) — full guide on bulk pricing

---

## Fetch cart with totals and tax breakdown

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-cart-with-totals

# Fetch cart with totals and tax breakdown

Retrieve the full cart including line items, subtotals, shipping costs, tax levels, and the grand total.

## Query

```graphql
query GetCart($cartId: String!) {
  cart(id: $cartId) {
    cartId
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    total {
      subTotal
      subTotalNet
      totalGross
      totalNet
      discount
      discountNet
    }
    taxLevels {
      taxPercentage
      price
    }
    postageData {
      method
      price
      priceNet
      carrier
    }
    actionCode
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

## Response

```json
{
  "data": {
    "cart": {
      "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728",
      "items": [
        {
          "itemId": "019c77b7-72a0-75fe-8a20-b98927d76652",
          "productId": 25,
          "quantity": 3,
          "price": 1595.04,
          "priceNet": 1929.9984,
          "totalPrice": 4785.12,
          "totalPriceNet": 5789.99
        }
      ],
      "total": {
        "subTotal": 4785.12,
        "subTotalNet": 5789.99,
        "totalGross": 5120.12,
        "totalNet": 6195.34,
        "discount": 0,
        "discountNet": 0
      },
      "taxLevels": [
        { "taxPercentage": 21, "price": 1075.22 }
      ],
      "postageData": {
        "method": "DELIVERY",
        "price": 300,
        "priceNet": 363,
        "carrier": null
      },
      "actionCode": ""
    }
  }
}
```

## How it works

`total.subTotal` is the sum of all line items excluding tax and shipping. `total.totalGross` adds shipping and payment costs but excludes tax, while `total.totalNet` is the final amount including tax. The `taxLevels` array breaks down the tax per rate — useful for displaying a tax summary when multiple VAT rates apply. The `price` / `priceNet` naming follows Propeller convention: `price` is gross (excluding tax), `priceNet` is net (including tax).

## See also

- [Add a product to cart](/frontend/recipes/add-product-to-cart)
- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — full cart lifecycle guide

---

## Fetch a category breadcrumb

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-category-breadcrumb

# Fetch a category breadcrumb

Get the full ancestor chain from root to the current category for breadcrumb navigation.

## Query

```graphql
query GetBreadcrumb($categoryId: Float!) {
  category(categoryId: $categoryId) {
    categoryId
    name { language value }
    categoryPath {
      categoryId
      name { language value }
      slug { language value }
    }
  }
}
```

## Variables

```json
{
  "categoryId": 1798
}
```

## Response

```json
{
  "data": {
    "category": {
      "categoryId": 1798,
      "name": [{ "language": "NL", "value": "2-in-1 Laptops" }],
      "categoryPath": [
        {
          "categoryId": 17,
          "name": [{ "language": "NL", "value": "PDM" }],
          "slug": [{ "language": "NL", "value": "pdm" }]
        },
        {
          "categoryId": 1794,
          "name": [{ "language": "NL", "value": "ICT and hardware" }],
          "slug": [{ "language": "NL", "value": "ict-and-hardware" }]
        },
        {
          "categoryId": 1795,
          "name": [{ "language": "NL", "value": "Computers / laptops" }],
          "slug": [{ "language": "NL", "value": "computers-laptops" }]
        }
      ]
    }
  }
}
```

## How it works

`categoryPath` returns ancestors from root to the immediate parent. It does **not** include the current category itself. Root categories return an empty array. You can pass `hidden: N` to `categoryPath` to exclude hidden ancestors from the breadcrumb.

## See also

- [Fetch a category by ID](/frontend/recipes/fetch-category-by-id)
- [Build a category navigation tree](/frontend/recipes/build-category-navigation-tree)

---

## Fetch a category by ID

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-category-by-id

# Fetch a category by ID

Retrieve a single category with its core data.

## Query

```graphql
query GetCategory($categoryId: Int!) {
  category(categoryId: $categoryId) {
    categoryId
    name { language value }
    description { language value }
    shortDescription { language value }
    slug { language value }
    hidden
    defaultLanguage
    path
  }
}
```

## Variables

```json
{
  "categoryId": 1795
}
```

## Response

```json
{
  "data": {
    "category": {
      "categoryId": 1795,
      "name": [
        { "language": "NL", "value": "Computers / laptops" }
      ],
      "description": [
        { "language": "NL", "value": "<p>Zakelijke computers en laptops</p>" }
      ],
      "shortDescription": [
        { "language": "NL", "value": "Computers en laptops" }
      ],
      "slug": [
        { "language": "NL", "value": "computers-laptops" }
      ],
      "hidden": "N",
      "defaultLanguage": "NL",
      "path": "100035/100092"
    }
  }
}
```

## How it works

The `path` field contains internal IDs (not categoryIds) separated by slashes, representing the path from root to this category. The `hidden` parameter on the query acts as a filter: `hidden: N` returns the category only if it is visible, `hidden: Y` only if hidden, omitted returns it regardless.

## See also

- [Fetch a category breadcrumb](/frontend/recipes/fetch-category-breadcrumb)
- [Build a category navigation tree](/frontend/recipes/build-category-navigation-tree)

---

## Fetch a cluster with options

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-cluster-with-options

# Fetch a cluster with options

Retrieve a cluster with its option groups (add-ons like monitors, warranty plans or accessories).

## Query

```graphql
query GetClusterOptions($clusterId: Int!, $taxZone: String!) {
  cluster(clusterId: $clusterId) {
    clusterId
    names { language value }
    options {
      clusterOptionId
      names { language value }
      isRequired
      hidden
      defaultProduct {
        productId
        names { language value }
      }
      products {
        productId
        sku
        names { language value }
        price(input: { taxZone: $taxZone }) {
          gross
          net
        }
      }
    }
  }
}
```

## Variables

```json
{
  "clusterId": 30,
  "taxZone": "NL"
}
```

## Response

```json
{
  "data": {
    "cluster": {
      "clusterId": 30,
      "names": [{ "language": "NL", "value": "Dell Optiplex 7010 bundel" }],
      "options": [
        {
          "clusterOptionId": 31,
          "names": [{ "language": "NL", "value": "Monitor" }],
          "isRequired": "Y",
          "hidden": "N",
          "defaultProduct": { "productId": 890, "names": [{ "language": "NL", "value": "Dell P2422H 24\"" }] },
          "products": [
            { "productId": 890, "sku": "DELL-P2422H", "names": [{ "language": "NL", "value": "Dell P2422H 24\"" }], "price": { "gross": 249, "net": 301.29 } },
            { "productId": 891, "sku": "DELL-P2723QE", "names": [{ "language": "NL", "value": "Dell P2723QE 27\" 4K" }], "price": { "gross": 449, "net": 543.29 } }
          ]
        },
        {
          "clusterOptionId": 32,
          "names": [{ "language": "NL", "value": "Garantie" }],
          "isRequired": "Y",
          "hidden": "N",
          "defaultProduct": null,
          "products": [
            { "productId": 895, "sku": "SVC-3Y-NEXT", "names": [{ "language": "NL", "value": "3 jaar next business day" }], "price": { "gross": 89, "net": 107.69 } },
            { "productId": 896, "sku": "SVC-5Y-NEXT", "names": [{ "language": "NL", "value": "5 jaar next business day" }], "price": { "gross": 159, "net": 192.39 } }
          ]
        }
      ]
    }
  }
}
```

## How it works

Options are add-on product groups. When `isRequired` is `Y`, the customer must select a product from that option to complete the configuration. Products inside an option have their `clusterId` set to the `clusterOptionId`, not the parent cluster's ID.

## See also

- [Fetch a cluster with its products](/frontend/recipes/fetch-cluster-with-products)
- [Fetch a cluster with variant selection config](/frontend/recipes/fetch-cluster-with-variant-config)

---

## Fetch a cluster with its products

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-cluster-with-products

# Fetch a cluster with its products

Retrieve a cluster and all its variant products.

## Query

```graphql
query GetCluster($clusterId: Int!, $taxZone: String!) {
  cluster(clusterId: $clusterId) {
    clusterId
    names { language value }
    descriptions { language value }
    categoryId
    hidden
    defaultProduct {
      productId
      names { language value }
    }
    products {
      productId
      sku
      names { language value }
      status
      orderable
      price(input: { taxZone: $taxZone }) {
        gross
        net
      }
    }
  }
}
```

## Variables

```json
{
  "clusterId": 30,
  "taxZone": "NL"
}
```

## Response

```json
{
  "data": {
    "cluster": {
      "clusterId": 30,
      "names": [{ "language": "NL", "value": "Dell Optiplex 7010 serie" }],
      "descriptions": [{ "language": "NL", "value": "<p>Zakelijke desktop-pc reeks</p>" }],
      "categoryId": 1796,
      "hidden": "N",
      "defaultProduct": {
        "productId": 880,
        "names": [{ "language": "NL", "value": "Dell Optiplex 7010 - i5 / 16GB / 512GB" }]
      },
      "products": [
        {
          "productId": 880,
          "sku": "DELL-7010-I5-16",
          "names": [{ "language": "NL", "value": "Dell Optiplex 7010 - i5 / 16GB / 512GB" }],
          "status": "A",
          "orderable": "Y",
          "price": { "gross": 749, "net": 906.29 }
        },
        {
          "productId": 881,
          "sku": "DELL-7010-I7-32",
          "names": [{ "language": "NL", "value": "Dell Optiplex 7010 - i7 / 32GB / 1TB" }],
          "status": "A",
          "orderable": "Y",
          "price": { "gross": 1149, "net": 1390.29 }
        }
      ]
    }
  }
}
```

## How it works

Each product in a cluster has its own independent price — there is no price inheritance from the cluster level. The `products` field is not paginated. Products inside the cluster have `categoryId: 0` and inherit their category from the cluster's `categoryId`.

## See also

- [Fetch a cluster with variant selection config](/frontend/recipes/fetch-cluster-with-variant-config)
- [Fetch a cluster with options](/frontend/recipes/fetch-cluster-with-options)

---

## Fetch a cluster with variant selection config

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-cluster-with-variant-config

# Fetch a cluster with variant selection config

Retrieve a cluster with its ClusterConfig to build a variant selector (e.g. processor dropdown, memory selector).

## Query

```graphql
query GetClusterVariants($clusterId: Int!) {
  cluster(clusterId: $clusterId) {
    clusterId
    names { language value }
    config {
      id
      name
      settings {
        id
        name
        displayType
        priority
      }
    }
    drillDowns {
      attributeId
      priority
      displayType
    }
    products {
      productId
      names { language value }
      attributes(input: { attributeDescription: { names: ["PROCESSOR", "RAM_GB"] } }) {
        items {
          attributeDescription { name }
          value {
            ... on AttributeTextValue { textValues { language values } }
            ... on AttributeIntValue { intValue }
          }
        }
      }
    }
  }
}
```

## Variables

```json
{
  "clusterId": 30
}
```

## Response

```json
{
  "data": {
    "cluster": {
      "clusterId": 30,
      "names": [{ "language": "NL", "value": "Dell Optiplex 7010 serie" }],
      "config": {
        "id": 8114,
        "name": "DESKTOP_CONFIG",
        "settings": [
          { "id": 101, "name": "PROCESSOR", "displayType": "DROPDOWN", "priority": 0 },
          { "id": 102, "name": "RAM_GB", "displayType": "DROPDOWN", "priority": 1 }
        ]
      },
      "drillDowns": [
        { "attributeId": "abc-123", "priority": 0, "displayType": "DROPDOWN" },
        { "attributeId": "def-456", "priority": 1, "displayType": "DROPDOWN" }
      ],
      "products": [
        {
          "productId": 880,
          "names": [{ "language": "NL", "value": "Dell Optiplex 7010 - i5 / 16GB / 512GB" }],
          "attributes": {
            "items": [
              { "attributeDescription": { "name": "PROCESSOR" }, "value": { "textValues": [{ "language": "NL", "values": ["Intel Core i5-13500"] }] } },
              { "attributeDescription": { "name": "RAM_GB" }, "value": { "intValue": 16 } }
            ]
          }
        },
        {
          "productId": 881,
          "names": [{ "language": "NL", "value": "Dell Optiplex 7010 - i7 / 32GB / 1TB" }],
          "attributes": {
            "items": [
              { "attributeDescription": { "name": "PROCESSOR" }, "value": { "textValues": [{ "language": "NL", "values": ["Intel Core i7-13700"] }] } },
              { "attributeDescription": { "name": "RAM_GB" }, "value": { "intValue": 32 } }
            ]
          }
        }
      ]
    }
  }
}
```

## How it works

The `config.settings` array defines which attributes the frontend uses for variant selection. `priority` controls display order (lower = first). `displayType` tells you how to render each selector: `DROPDOWN` for a select menu, `RADIO` for radio buttons, `COLOR` for color swatches, `IMAGE` for image swatches. When a customer selects values for all settings, match against product attributes to find the corresponding product.

## See also

- [Fetch a cluster with its products](/frontend/recipes/fetch-cluster-with-products)
- [Fetch a cluster with options](/frontend/recipes/fetch-cluster-with-options)

---

## Fetch customer addresses

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-customer-addresses

# Fetch customer addresses

Retrieve all delivery addresses for a company, useful for the address book and checkout address selector.

## Query

```graphql
query GetCompanyAddresses($companyId: Float!, $type: AddressType) {
  addressesByCompanyId(companyId: $companyId, type: $type) {
    id
    firstName
    lastName
    company
    street
    number
    numberExtension
    postalCode
    city
    country
    isDefault
    type
    name
    phone
    email
  }
}
```

## Variables

```json
{
  "companyId": 141,
  "type": "delivery"
}
```

## Response

```json
{
  "data": {
    "addressesByCompanyId": [
      {
        "id": 81166,
        "firstName": "Philippe",
        "lastName": "Barril",
        "company": "ASML Veldhoven",
        "street": "De Run",
        "number": "6501",
        "numberExtension": null,
        "postalCode": "5504 DR",
        "city": "Veldhoven",
        "country": "NL",
        "isDefault": "N",
        "type": "delivery",
        "name": "",
        "phone": null,
        "email": null
      },
      {
        "id": 82101,
        "firstName": "Andre",
        "lastName": "Vries",
        "company": "ASML Veldhoven",
        "street": "De Run",
        "number": "1120",
        "numberExtension": null,
        "postalCode": "5503 LA",
        "city": "Veldhoven",
        "country": "NL",
        "isDefault": "Y",
        "type": "delivery",
        "name": "",
        "phone": null,
        "email": null
      }
    ]
  }
}
```

## How it works

Pass the `companyId` from the logged-in user's profile. The optional `type` argument filters by address type: use `delivery` or `invoice`. Omit it to get all addresses. The `isDefault` field indicates which address should be pre-selected in the checkout. The `id` field can be used to populate the cart address via `cartUpdateAddress`. There is also `addressesByCustomerId` for B2C customers and `addressesByUserId` for direct user lookups.

## See also

- [Get the logged-in user](/frontend/recipes/get-logged-in-user)
- [Set addresses on the cart](/frontend/recipes/set-cart-addresses)

---

## Fetch favorite lists with products

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-favorite-lists

# Fetch favorite lists with products

Retrieve the user's favorite (wish) lists with their products.

## Query

```graphql
query GetFavoriteLists($offset: Int, $page: Int) {
  favoriteLists(input: { offset: $offset, page: $page }) {
    items {
      id
      name
      isDefault
      slug
      createdAt
      products(input: { offset: 5 }) {
        items {
          ... on Product {
            productId
            names(language: "NL") { value }
            sku
          }
        }
        itemsFound
      }
    }
    itemsFound
  }
}
```

## Variables

```json
{
  "offset": 10,
  "page": 1
}
```

## Response

```json
{
  "data": {
    "favoriteLists": {
      "items": [
        {
          "id": "66a21b15dd2e049b327c6434",
          "name": "Michurin studio center",
          "isDefault": false,
          "slug": "michurin-studio-center",
          "createdAt": "2024-07-25T09:29:57.242Z",
          "products": {
            "items": [
              {
                "productId": 39,
                "names": [{ "value": "HP ProBook 450 G8 Notebook 39.6 cm Full HD Intel® Windows 10 Pro Silver" }],
                "sku": "203F7EA#ABH"
              }
            ],
            "itemsFound": 1
          }
        },
        {
          "id": "66d6ab6e590599fecc3fa5a2",
          "name": "IT supplies afdeling management",
          "isDefault": false,
          "slug": "it-supplies-afdeling-management",
          "createdAt": "2024-09-03T06:23:42.983Z",
          "products": {
            "items": [
              {
                "productId": 41,
                "names": [{ "value": "Acer Aspire 3 Spin Laptop A3SP14-31PT | Zilver" }],
                "sku": "NX.KENEH.007"
              },
              {
                "productId": 44,
                "names": [{ "value": "Logitech MX Mechanical Wireless Keyboard + Logitech MX Master 3S" }],
                "sku": "908468"
              }
            ],
            "itemsFound": 5
          }
        }
      ],
      "itemsFound": 18
    }
  }
}
```

## How it works

Favorite lists are scoped to the authenticated user's contact or company. Each list has a nested `products` connection that supports its own pagination via the `input` argument. The `isDefault` field indicates which list is the primary one. Products inside favorite lists are returned as the `Product` union type, so use an inline fragment (`... on Product`) to access product fields. Lists can also contain clusters — use `... on Cluster` for those.

## See also

- [Add or remove a product from a favorite list](/frontend/recipes/manage-favorite-list-items)

---

## Fetch quote or order detail

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-order-detail

# Fetch quote or order detail

Retrieve the full details of an order or quote request, including line items, totals, and addresses.

## Query

```graphql
query GetOrderDetail($orderId: Int!) {
  order(orderId: $orderId) {
    id
    status
    type
    reference
    remarks
    email
    createdAt
    items {
      id
      productId
      name
      sku
      quantity
      price
      priceTotal
      priceNet
      priceTotalNet
      taxPercentage
    }
    total {
      gross
      net
      tax
      taxPercentages {
        percentage
        total
      }
    }
    addresses(type: invoice) {
      firstName
      lastName
      company
      street
      number
      postalCode
      city
      country
    }
    postageData {
      method
      gross
      net
      taxPercentage
      carrier
    }
  }
}
```

## Variables

```json
{
  "orderId": 2791
}
```

## Response

```json
{
  "data": {
    "order": {
      "id": 2791,
      "status": "REQUEST",
      "type": "dropshipment",
      "reference": null,
      "remarks": null,
      "email": "mark+merford@propel.us",
      "createdAt": "2026-02-12T13:09:16.142Z",
      "items": [
        {
          "id": 26771,
          "productId": 1877,
          "name": "Rvs 316 kogelafsluiter inw/inw. 2-delig volle doorlaat",
          "sku": "2440-0280-1",
          "quantity": 3,
          "price": 37.41,
          "priceTotal": 112.23,
          "priceNet": 37.41,
          "priceTotalNet": 112.23,
          "taxPercentage": 0
        }
      ],
      "total": {
        "gross": 917.23,
        "net": 917.23,
        "tax": 0,
        "taxPercentages": [
          { "percentage": 0, "total": 0 }
        ]
      },
      "addresses": [
        {
          "firstName": "Mark",
          "lastName": "Egmond",
          "company": "Merford Cabins B.V.",
          "street": "Industrieweg",
          "number": "16",
          "postalCode": "4283 GZ",
          "city": "Giessen",
          "country": "NL"
        }
      ],
      "postageData": {
        "method": "REGULAR",
        "gross": 750,
        "net": 750,
        "taxPercentage": 0,
        "carrier": null
      }
    }
  }
}
```

## How it works

The `order` query accepts either `orderId` (integer) or `orderUUID` (string). It works for both regular orders and quote requests — check the `type` and `status` fields to distinguish them. The `addresses` field accepts an optional `type` argument to filter by `invoice` or `delivery`. Order totals use `gross` (excluding tax) and `net` (including tax), which differs from the cart's naming (`totalGross` / `totalNet`). The `taxPercentages` array breaks down the tax per rate.

## See also

- [Fetch quote list](/frontend/recipes/fetch-quote-list)
- [Convert a quote into an order](/frontend/recipes/convert-quote-to-order)

---

## Fetch order history with status filtering

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-order-history-with-status-filtering

# Fetch order history with status filtering

Query past orders for the logged-in contact, filtered by status with pagination.

## Query

```graphql
query GetOrders($status: [String!], $page: Int, $offset: Int) {
  orders(input: { status: $status, page: $page, offset: $offset }) {
    items {
      id
      status
      createdAt
      reference
      total {
        gross
        net
        tax
      }
      items {
        id
        productId
        name
        quantity
      }
    }
    itemsFound
    page
    pages
  }
}
```

## Variables

```json
{
  "status": ["NEW", "CONFIRMED"],
  "page": 1,
  "offset": 10
}
```

## Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": "ord-12345",
          "status": "CONFIRMED",
          "createdAt": "2025-01-15T10:30:00.000Z",
          "reference": "PO-2025-0042",
          "total": { "gross": 1250.00, "net": 1512.50, "tax": 262.50 },
          "items": [
            { "id": "item-1", "productId": 1895, "name": "HP ProBook 450 G10 i5", "quantity": 1 }
          ]
        }
      ],
      "itemsFound": 24,
      "page": 1,
      "pages": 3
    }
  }
}
```

## How it works

Available filters: `status`, `createdAt`, `price`, `userId`, `companyIds`, `type` (e.g., `dropshipment`, `purchase`, `quotation`). You can filter by date range with `createdAt: { greaterThan: "2024-01-01", lessThan: "2024-12-31" }` or by company with `companyIds: [678]` for B2B use cases.

## See also

- [Order history](/frontend/domain-guides/orders-and-shipments/order-history) — full guide on order history, details and filtering

---

## Fetch available payment methods

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-payment-methods

# Fetch available payment methods

Retrieve the list of payment methods available for the current cart.

## Query

```graphql
query GetPaymentMethods($cartId: String!) {
  cart(id: $cartId) {
    payMethods {
      name
      code
      externalCode
      type
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

## Response

```json
{
  "data": {
    "cart": {
      "payMethods": [
        { "name": "On pickup", "code": "AFHALEN", "externalCode": null, "type": "EUR" },
        { "name": "Visa", "code": "CREDITCARD", "externalCode": null, "type": "EUR" },
        { "name": "Mastercard", "code": "MASTERCARD", "externalCode": null, "type": "EUR" },
        { "name": "PayPal", "code": "PAYPAL", "externalCode": null, "type": "EUR" },
        { "name": "On account", "code": "REKENING", "externalCode": null, "type": "EUR" }
      ]
    }
  }
}
```

## How it works

The available payment methods depend on the cart context — the logged-in user, their company, and business rules may filter the list. Use the `code` value when setting the payment method on the cart via `cartUpdate`. The `externalCode` maps to your payment service provider's method identifier when a PSP integration is configured. Display the `name` field to the user in the checkout UI.

## See also

- [Fetch available shipping methods](/frontend/recipes/fetch-shipping-methods)
- [Place an order from the cart](/frontend/recipes/place-order)

---

## Fetch product attributes as specifications

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-attributes

# Fetch product attributes as specifications

Retrieve a product's attributes to display as a specifications table on the product detail page.

## Query

```graphql
query GetProductAttributes($productId: Int!, $language: String) {
  product(productId: $productId) {
    productId
    names(language: $language) { value }
    attributes(input: { offset: 50 }) {
      items {
        attributeDescription {
          name
          descriptions { language value }
          type
          group
        }
        value {
          ... on AttributeTextValue { textValues { language values } }
          ... on AttributeEnumValue { enumValues }
          ... on AttributeIntValue { intValue }
          ... on AttributeDecimalValue { decimalValue }
          ... on AttributeColorValue { colorValue }
        }
      }
      itemsFound
    }
  }
}
```

## Variables

```json
{
  "productId": 25,
  "language": "NL"
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 25,
      "names": [{ "value": "Dovre SAGA 1001" }],
      "attributes": {
        "items": [
          {
            "attributeDescription": {
              "name": "ONDERSTEL_KLEUR",
              "descriptions": [{ "language": "NL", "value": "Kleur van het onderstel (frame)" }],
              "type": "COLOR",
              "group": "Kantoormeubilair"
            },
            "value": {
              "colorValue": "#FFFFFF"
            }
          },
          {
            "attributeDescription": {
              "name": "RUO_STATEMENT",
              "descriptions": [
                { "language": "EN", "value": "Research Use Only statement" },
                { "language": "NL", "value": "Research Use Only statement" }
              ],
              "type": "TEXT",
              "group": "RPIP"
            },
            "value": {
              "textValues": [
                { "language": "EN", "values": [] },
                { "language": "NL", "values": null }
              ]
            }
          }
        ],
        "itemsFound": 96
      }
    }
  }
}
```

## How it works

The `value` field is a union type — use inline fragments to handle each attribute type: `AttributeTextValue` for text, `AttributeEnumValue` for dropdowns, `AttributeIntValue` and `AttributeDecimalValue` for numbers, and `AttributeColorValue` for colors. The `attributeDescription.descriptions` array contains the human-readable label per language, which you display as the specification name. Group attributes by the `group` field to create specification sections. Filter out attributes with empty or null values before rendering.

## See also

- [Fetch a product with pricing](/frontend/recipes/fetch-product-with-pricing)
- [Search products with faceted filters](/frontend/recipes/search-products-with-faceted-filters)

---

## Fetch a product by ID

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-by-id

# Fetch a product by ID

Retrieve a single product using its `productId`.

## Query

```graphql
query GetProduct($productId: Int!) {
  product(productId: $productId) {
    productId
    sku
    names { language value }
    descriptions { language value }
    shortDescriptions { language value }
    manufacturer
    supplier
    status
    orderable
    hidden
    categoryId
    containerClass
    clusterId
  }
}
```

## Variables

```json
{
  "productId": 1895
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" },
        { "language": "EN", "value": "HP ProBook 450 G10 i5" }
      ],
      "descriptions": [
        { "language": "NL", "value": "<p>Zakelijke laptop met 15.6 inch scherm</p>" }
      ],
      "shortDescriptions": [
        { "language": "NL", "value": "15.6\" i5 laptop" }
      ],
      "manufacturer": "HP",
      "supplier": "Ingram Micro",
      "status": "A",
      "orderable": "Y",
      "hidden": "N",
      "categoryId": 1795,
      "containerClass": "PRODUCT",
      "clusterId": null
    }
  }
}
```

## How it works

Use `productId` for lookups. The deprecated `id` field still works but should be avoided. If the product does not exist, the API returns `null`. Products that belong to a cluster have a `clusterId` set and `containerClass: "CLUSTER"`.

## See also

- [Fetch a product by SKU](/frontend/recipes/fetch-product-by-sku)
- [Fetch a product by slug](/frontend/recipes/fetch-product-by-slug)

---

## Fetch a product by SKU

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-by-sku

# Fetch a product by SKU

Retrieve a product using its SKU when you don't have the `productId`.

## Query

```graphql
query GetProductBySku($sku: String!) {
  product(sku: $sku) {
    productId
    sku
    names { language value }
    manufacturer
    status
  }
}
```

## Variables

```json
{
  "sku": "HP-450G10-I5"
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" }
      ],
      "manufacturer": "HP",
      "status": "A"
    }
  }
}
```

## How it works

SKU is a unique identifier. If no product matches the SKU, the API returns `null`.

## See also

- [Fetch a product by ID](/frontend/recipes/fetch-product-by-id)
- [Fetch a product by slug](/frontend/recipes/fetch-product-by-slug)

---

## Fetch a product by slug

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-by-slug

# Fetch a product by slug

Retrieve a product using its URL-friendly slug. Useful when resolving storefront URLs.

## Query

```graphql
query GetProductBySlug($slug: String!, $language: String!) {
  product(slug: $slug, language: $language) {
    productId
    sku
    names { language value }
    slugs { language value }
  }
}
```

## Variables

```json
{
  "slug": "hp-probook-450",
  "language": "NL"
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" }
      ],
      "slugs": [
        { "language": "NL", "value": "hp-probook-450" }
      ]
    }
  }
}
```

## How it works

Slugs can differ per language. Pass the `language` variable to match the correct localized slug. If you omit `language`, the system matches against the default language.

## See also

- [Fetch a product by ID](/frontend/recipes/fetch-product-by-id)
- [Fetch a product by SKU](/frontend/recipes/fetch-product-by-sku)

---

## Fetch product documents

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-documents

# Fetch product documents

Retrieve downloadable documents (PDFs, datasheets, manuals) attached to a product.

## Query

```graphql
query GetProductDocuments($productId: Int!) {
  product(productId: $productId) {
    productId
    media {
      documents {
        items {
          id
          type
          priority
          alt(language: "NL") { language value }
          description(language: "NL") { language value }
          documents {
            language
            originalUrl
            mimeType
          }
        }
        itemsFound
      }
    }
  }
}
```

## Variables

```json
{
  "productId": 25
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 25,
      "media": {
        "documents": {
          "items": [
            {
              "id": "c277d06a-5bed-4bd6-809b-d833387447cc",
              "type": "DOCUMENT",
              "priority": 1000,
              "alt": [{ "language": "NL", "value": "Brochure-Dovre-Saga-.pdf" }],
              "description": [{ "language": "NL", "value": "Brochure-Dovre-Saga-.pdf" }],
              "documents": [
                {
                  "language": "en",
                  "originalUrl": "https://media.helice.cloud/newbo.helice.cloud/documents/en/c277d06a-5bed-4bd6-809b-d833387447cc-Brochure-Dovre-Saga-.pdf",
                  "mimeType": "application/pdf"
                }
              ]
            },
            {
              "id": "44225fc6-3dae-439a-86e8-35480163aa51",
              "type": "DOCUMENT",
              "priority": 1000,
              "alt": [{ "language": "NL", "value": "Installatievoorschriften.pdf" }],
              "description": [{ "language": "NL", "value": "Installatievoorschriften.pdf" }],
              "documents": [
                {
                  "language": "en",
                  "originalUrl": "https://media.helice.cloud/newbo.helice.cloud/documents/en/44225fc6-3dae-439a-86e8-35480163aa51-Installatievoorschriften.pdf",
                  "mimeType": "application/pdf"
                }
              ]
            }
          ],
          "itemsFound": 2
        }
      }
    }
  }
}
```

## How it works

Each `MediaDocument` item contains a nested `documents` array with the actual file URLs per language. Use `originalUrl` to link to the downloadable file. The `description` and `alt` fields provide display names — pass a `language` argument to filter them. The `mimeType` tells you the file format (e.g., `application/pdf`). Sort by `priority` for display order (lower values appear first). The `documents` response is paginated — pass a `search` argument with `page` and `offset` if the product has many documents.

## See also

- [Fetch product videos](/frontend/recipes/fetch-product-videos)
- [Get product images with transformations](/frontend/recipes/get-product-images-with-transformations)

---

## Fetch product stock across warehouses

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-stock

# Fetch product stock across warehouses

Check real-time inventory for a product, broken down by warehouse location, including supplier stock and next delivery date.

## Query

```graphql
query GetProductStock($productId: Int!) {
  product(productId: $productId) {
    productId
    inventory {
      totalQuantity
      localQuantity
      supplierQuantity
      nextDeliveryDate
      balance {
        quantity
        warehouseId
      }
    }
  }
}
```

## Variables

```json
{
  "productId": 12345
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 12345,
      "inventory": {
        "totalQuantity": 340,
        "localQuantity": 200,
        "supplierQuantity": 140,
        "nextDeliveryDate": "2026-03-01",
        "balance": [
          { "quantity": 120, "warehouseId": 1 },
          { "quantity": 80, "warehouseId": 2 }
        ]
      }
    }
  }
}
```

## How it works

`totalQuantity` is the sum of `localQuantity` (your own warehouses) and `supplierQuantity` (external suppliers). The `balance` array breaks stock down per warehouse so you can show regional availability or route orders to the nearest fulfillment location.

---

## Fetch product videos

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-videos

# Fetch product videos

Retrieve videos attached to a product for embedding on the product detail page.

## Query

```graphql
query GetProductVideos($productId: Int!) {
  product(productId: $productId) {
    productId
    media {
      videos {
        items {
          id
          type
          priority
          description(language: "NL") { language value }
          videos {
            language
            uri
            mimeType
          }
        }
        itemsFound
      }
    }
  }
}
```

## Variables

```json
{
  "productId": 25
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 25,
      "media": {
        "videos": {
          "items": [
            {
              "id": "06ca1458-15aa-4634-a843-c5b7585c4cab",
              "type": "VIDEO",
              "priority": 1000,
              "description": [{ "language": "NL", "value": "SAGA101 - SAGA107" }],
              "videos": [
                {
                  "language": "NL",
                  "uri": "https://www.youtube.com/embed/DJDVrhqLm20",
                  "mimeType": "video/mp4"
                }
              ]
            }
          ],
          "itemsFound": 1
        }
      }
    }
  }
}
```

## How it works

Each `MediaVideo` item contains a nested `videos` array with the video URIs per language. The `uri` field typically contains a YouTube or Vimeo embed URL that you can use directly in an `<iframe>`. For self-hosted videos, use the `uri` as the `<video>` source and check `mimeType` for the format. The `description` field provides a display caption. Sort by `priority` for display order (lower values appear first). The `videos` response is paginated — pass a `search` argument with `page` and `offset` if the product has many videos.

## See also

- [Fetch product documents](/frontend/recipes/fetch-product-documents)
- [Get product images with transformations](/frontend/recipes/get-product-images-with-transformations)

---

## Fetch a product with pricing

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-product-with-pricing

# Fetch a product with pricing

Retrieve a product together with its base price and calculated price for a specific quantity and tax zone.

## Query

```graphql
query GetProductWithPricing($productId: Int!, $taxZone: String!) {
  product(productId: $productId) {
    productId
    sku
    names { language value }
    priceData {
      id
      list
      cost
      suggested
      store
      per
      defaultTaxCode
      costPrices {
        quantityFrom
        value
      }
    }
    price(input: { taxZone: $taxZone }) {
      net
      gross
      list
      cost
      taxCode
      type
      quantity
    }
  }
}
```

## Variables

```json
{
  "productId": 1895,
  "taxZone": "NL"
}
```

## Response

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" }
      ],
      "priceData": {
        "id": "01948326-33e3-7a1b-9d2f-abc123def456",
        "list": 15,
        "cost": null,
        "suggested": null,
        "store": null,
        "per": 1,
        "defaultTaxCode": "H",
        "costPrices": []
      },
      "price": {
        "net": 18.15,
        "gross": 15,
        "list": 15,
        "cost": null,
        "taxCode": "H",
        "type": "DEFAULT",
        "quantity": 1
      }
    }
  }
}
```

## How it works

`priceData` returns the raw price record. `price(input)` returns the calculated price after tax and pricesheets are applied. The naming convention is counterintuitive: `gross` is the base price (before tax) and `net` is the final price (after tax). Tax code `H` in zone NL applies 21% VAT, so `net` = `gross` × 1.21.

## See also

- [Display tiered and bulk pricing](/frontend/recipes/display-tiered-and-bulk-pricing)
- [Query products with customer-specific pricing](/frontend/recipes/query-products-with-customer-pricing)

---

## Fetch products by multiple IDs

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-products-by-multiple-ids

# Fetch products by multiple IDs

Retrieve a batch of products by their IDs in a single query.

## Query

```graphql
query GetProductsByIds($productIds: [Int!]!) {
  products(input: {
    productIds: $productIds
  }) {
    itemsFound
    items {
      ... on Product {
        productId
        sku
        names { language value }
        status
      }
    }
  }
}
```

## Variables

```json
{
  "productIds": [25, 1895, 1920]
}
```

## Response

```json
{
  "data": {
    "products": {
      "itemsFound": 3,
      "items": [
        { "productId": 25, "sku": "BOSCH-GBH-2-26", "names": [{ "language": "NL", "value": "Bosch GBH 2-26 boorhamer" }], "status": "A" },
        { "productId": 1895, "sku": "HP-450G10-I5", "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }], "status": "A" },
        { "productId": 1920, "sku": "LN-T14S-G4", "names": [{ "language": "NL", "value": "Lenovo ThinkPad T14s Gen 4" }], "status": "A" }
      ]
    }
  }
}
```

## How it works

Only returns products with status `A` by default. If some of your IDs refer to products with other statuses, add `statuses: [A, N, P, S, R, T]` to get them all. The same pattern works for `skus: [...]` to batch-fetch by SKU.

## See also

- [Fetch a product by ID](/frontend/recipes/fetch-product-by-id)
- [Filter products by status](/frontend/recipes/filter-products-by-status)

---

## Fetch quote list

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-quote-list

# Fetch quote list

Retrieve a paginated list of quotes that the sales team has prepared for the customer.

## Query

```graphql
query GetQuotes($page: Int, $offset: Int) {
  orders(input: {
    type: [quotation]
    status: ["QUOTATION"]
    page: $page
    offset: $offset
  }) {
    items {
      id
      status
      reference
      remarks
      createdAt
      total {
        gross
        net
        tax
      }
    }
    itemsFound
    page
    pages
  }
}
```

## Variables

```json
{
  "page": 1,
  "offset": 10
}
```

## Response

```json
{
  "data": {
    "orders": {
      "items": [
        {
          "id": 2792,
          "status": "QUOTATION",
          "reference": null,
          "remarks": null,
          "createdAt": "2026-02-12T13:21:34.588Z",
          "total": {
            "gross": 990.5,
            "net": 1198.51,
            "tax": 208.01
          }
        },
        {
          "id": 2774,
          "status": "QUOTATION",
          "reference": null,
          "remarks": null,
          "createdAt": "2026-02-10T08:11:35.474Z",
          "total": {
            "gross": 13069.45,
            "net": 13069.45,
            "tax": 0
          }
        }
      ],
      "itemsFound": 109,
      "page": 1,
      "pages": 11
    }
  }
}
```

## How it works

Quotes are orders with `type: quotation` and `status: "QUOTATION"` — these are created by the sales team in response to a customer's quote request. Don't confuse them with quote requests, which have `type: dropshipment` and `status: "REQUEST"`. The `total.gross` is the amount excluding tax, `total.net` includes tax. Use the `id` from a list item to fetch the full quote detail with the `order` query. From the customer portal, the customer can confirm a quote into an order using `orderSetStatus`.

## See also

- [Fetch quote or order detail](/frontend/recipes/fetch-order-detail)
- [Convert a quote into an order](/frontend/recipes/convert-quote-to-order)
- [Submit a quote request from the cart](/frontend/recipes/submit-quote-request-from-cart)

---

## Fetch available shipping methods and carriers

URL: https://docs.propeller-commerce.com/frontend/recipes/fetch-shipping-methods

# Fetch available shipping methods and carriers

Retrieve the shipping methods and carriers available for the current cart.

## Query

```graphql
query GetShippingOptions($cartId: String!) {
  cart(id: $cartId) {
    shippingMethods {
      name
      code
    }
    carriers {
      id
      name
      logo
      price
    }
    postageData {
      method
      price
      priceNet
      carrier
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

## Response

```json
{
  "data": {
    "cart": {
      "shippingMethods": [
        { "name": "Delivery", "code": "DELIVERY" },
        { "name": "Pickup", "code": "PICKUP" }
      ],
      "carriers": [
        { "id": 1, "name": "Default delivery", "logo": null, "price": 10 },
        { "id": 8, "name": "DHL", "logo": null, "price": 2.36 },
        { "id": 25, "name": "DPD", "logo": null, "price": 0 },
        { "id": 26, "name": "GLS", "logo": null, "price": 0 },
        { "id": 2, "name": "PostNL", "logo": null, "price": 4.5 }
      ],
      "postageData": {
        "method": "DELIVERY",
        "price": 300,
        "priceNet": 363,
        "carrier": null
      }
    }
  }
}
```

## How it works

`shippingMethods` lists the available methods (typically Delivery and Pickup). `carriers` lists the available carriers with their indicative prices — actual shipping costs are calculated through business rules and reflected in `postageData`. The `postageData` object shows the currently selected method and the calculated shipping costs. Use `cartUpdate` with `postageData.method` and optionally a carrier to set the shipping choice.

## See also

- [Fetch available payment methods](/frontend/recipes/fetch-payment-methods)
- [Place an order from the cart](/frontend/recipes/place-order)

---

## Filter products by status

URL: https://docs.propeller-commerce.com/frontend/recipes/filter-products-by-status

# Filter products by status

Retrieve products filtered by one or more statuses.

## Query

```graphql
query FilterByStatus($statuses: [ProductStatus!]) {
  products(input: {
    statuses: $statuses
  }) {
    itemsFound
    items {
      ... on Product {
        productId
        sku
        status
        orderable
      }
    }
  }
}
```

## Variables

```json
{
  "statuses": ["A", "N", "P"]
}
```

## Response

```json
{
  "data": {
    "products": {
      "itemsFound": 477,
      "items": [
        { "productId": 25, "sku": "BOSCH-GBH-2-26", "status": "A", "orderable": "Y" },
        { "productId": 117, "sku": "MKT-BROCHURE-A4", "status": "N", "orderable": "Y" }
      ]
    }
  }
}
```

## How it works

Without `statuses`, the query only returns products with status `A` (Available). To include all statuses, pass `["A", "N", "P", "S", "R", "T"]`. The `status` and `orderable` fields are independent and can conflict — a product can have status `N` but `orderable: Y`. Your application should check both fields.

**Status codes:** `A` = Available, `N` = Not Available, `P` = Phase Out, `S` = Presale, `R` = Restricted, `T` = Out of Stock.

## See also

- [Search products with a text query](/frontend/recipes/search-products-with-text-query)

---

## Get the logged-in user

URL: https://docs.propeller-commerce.com/frontend/recipes/get-logged-in-user

# Get the logged-in user

Retrieve the currently authenticated user's profile and company information.

## Query

```graphql
query GetViewer {
  viewer {
    ... on Contact {
      contactId
      firstName
      lastName
      email
      gender
      primaryLanguage
      company {
        companyId
        name
      }
    }
  }
}
```

## Response

```json
{
  "data": {
    "viewer": {
      "contactId": 1042,
      "firstName": "Jan",
      "lastName": "de Vries",
      "email": "jan@acme.nl",
      "gender": "M",
      "primaryLanguage": "NL",
      "company": {
        "companyId": 141,
        "name": "ASML Veldhoven"
      }
    }
  }
}
```

## How it works

The `viewer` query returns the user associated with the current JWT token. It returns the `IBaseUser` interface, so use an inline fragment (`... on Contact`) to access contact-specific fields like `contactId` and `company`. If no user is authenticated, the query returns `null`. This query is typically called on page load to check the session state and populate the header with the user's name and company.

## See also

- [Log in and get access tokens](/frontend/recipes/login)
- [Fetch customer addresses](/frontend/recipes/fetch-customer-addresses)

---

## Get product images with responsive transformations

URL: https://docs.propeller-commerce.com/frontend/recipes/get-product-images-with-transformations

# Get product images with responsive transformations

Fetch product media with on-the-fly image resizing and format conversion for different viewport sizes.

## Query

```graphql
query GetProductImages($productId: Int!, $language: String) {
  product(productId: $productId) {
    ... on Product {
      media {
        images(search: { sort: ASC, page: 1, offset: 12 }) {
          items {
            alt(language: $language) {
              value
            }
            priority
            imageVariants(
              input: {
                transformations: [
                  {
                    name: "thumbnail"
                    transformation: {
                      width: 100
                      height: 100
                      fit: BOUNDS
                      format: WEBP
                    }
                  }
                  {
                    name: "medium"
                    transformation: {
                      width: 400
                      height: 400
                      fit: BOUNDS
                      format: WEBP
                    }
                  }
                  {
                    name: "large"
                    transformation: {
                      width: 800
                      height: 800
                      fit: BOUNDS
                      format: WEBP
                    }
                  }
                ]
              }
            ) {
              url
              name
            }
          }
          itemsFound
        }
      }
    }
  }
}
```

## Variables

```json
{
  "productId": 123,
  "language": "EN"
}
```

## Response

```json
{
  "data": {
    "product": {
      "media": {
        "images": {
          "items": [
            {
              "alt": [{ "value": "Product front view" }],
              "priority": 1,
              "imageVariants": [
                { "url": "https://media.example.com/images/product-front.png?fit=bounds&format=webp&width=100&height=100", "name": "thumbnail" },
                { "url": "https://media.example.com/images/product-front.png?fit=bounds&format=webp&width=400&height=400", "name": "medium" },
                { "url": "https://media.example.com/images/product-front.png?fit=bounds&format=webp&width=800&height=800", "name": "large" }
              ]
            },
            {
              "alt": [{ "value": "Product side view" }],
              "priority": 2,
              "imageVariants": [
                { "url": "https://media.example.com/images/product-side.jpg?fit=bounds&format=webp&width=100&height=100", "name": "thumbnail" },
                { "url": "https://media.example.com/images/product-side.jpg?fit=bounds&format=webp&width=400&height=400", "name": "medium" },
                { "url": "https://media.example.com/images/product-side.jpg?fit=bounds&format=webp&width=800&height=800", "name": "large" }
              ]
            }
          ],
          "itemsFound": 2
        }
      }
    }
  }
}
```

## How it works

Each image has multiple variants identified by the `name` you defined in the query. Use `thumbnail` for listings and `large` for detail pages. The `fit` mode controls resizing: `BOUNDS` fits within the dimensions, `COVER` fills and crops, `CONTAIN` fits with padding. Supported output formats are `WEBP`, `JPEG`, and `PNG`. Images are sorted by `priority` (lower = first).

## See also

- [Media and assets](/frontend/domain-guides/products-and-catalog/media-and-assets) — full guide on images, videos and documents

---

## Frontend Recipes

URL: https://docs.propeller-commerce.com/frontend/recipes

# Frontend Recipes

Raw GraphQL queries and mutations that work for every frontend implementation (Storefront SDK, WordPress or custom).

---

## List channels

URL: https://docs.propeller-commerce.com/frontend/recipes/list-channels

# List channels

Retrieve all channels configured in the platform. Each channel represents a separate storefront or sales context with its own catalog root and anonymous user.

## Query

```graphql
query GetChannels {
  channels {
    channelId
    name
    catalogRootId
    anonymousUserId
  }
}
```

## Response

```json
{
  "data": {
    "channels": [
      {
        "channelId": 71,
        "name": "BUREAUSTOELENKOPEN.nl",
        "catalogRootId": 2050,
        "anonymousUserId": 14551
      },
      {
        "channelId": 1,
        "name": "B2B Webshop",
        "catalogRootId": 100092,
        "anonymousUserId": 14551
      }
    ]
  }
}
```

## How it works

The `channels` query returns all channels without pagination. Each channel has a `catalogRootId` that determines which part of the category tree is visible to users browsing that channel. The `anonymousUserId` sets the default user context for unauthenticated visitors, controlling which prices and product visibility rules apply.

## See also

- [Create a channel](/frontend/recipes/create-a-channel) — add a new storefront
- [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) — how catalog roots control product visibility

---

## List products in a category

URL: https://docs.propeller-commerce.com/frontend/recipes/list-products-in-category

# List products in a category

Get all products and clusters within a category, with filtering and pagination.

## Query

```graphql
query GetCategoryProducts($categoryId: Float!, $page: Int, $offset: Int, $taxZone: String!) {
  category(categoryId: $categoryId) {
    categoryId
    name { language value }
    products(input: {
      getDescendants: true
      page: $page
      offset: $offset
    }) {
      itemsFound
      page
      pages
      minPrice
      maxPrice
      items {
        ... on Product {
          productId
          sku
          names { language value }
          price(input: { taxZone: $taxZone }) { gross net }
        }
        ... on Cluster {
          clusterId
          names { language value }
          defaultProduct {
            productId
            price(input: { taxZone: $taxZone }) { gross net }
          }
        }
      }
    }
  }
}
```

## Variables

```json
{
  "categoryId": 1795,
  "page": 1,
  "offset": 20,
  "taxZone": "NL"
}
```

## Response

```json
{
  "data": {
    "category": {
      "categoryId": 1795,
      "name": [{ "language": "NL", "value": "Computers / laptops" }],
      "products": {
        "itemsFound": 42,
        "page": 1,
        "pages": 3,
        "minPrice": 299,
        "maxPrice": 3499,
        "items": [
          {
            "productId": 1895,
            "sku": "HP-450G10-I5",
            "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }],
            "price": { "gross": 899, "net": 1087.79 }
          },
          {
            "clusterId": 190,
            "names": [{ "language": "NL", "value": "Dell Latitude 5540 serie" }],
            "defaultProduct": {
              "productId": 92275,
              "price": { "gross": 1049, "net": 1269.29 }
            }
          }
        ]
      }
    }
  }
}
```

## How it works

Set `getDescendants: false` to only get products placed directly in this category (not in child categories). The `minPrice` and `maxPrice` fields reflect the price range across the full result set, useful for price sliders. Results contain both Products and Clusters, so use inline fragments.

## See also

- [Search products with faceted filters](/frontend/recipes/search-products-with-faceted-filters)
- [Fetch a category by ID](/frontend/recipes/fetch-category-by-id)

---

## Log in and get access tokens

URL: https://docs.propeller-commerce.com/frontend/recipes/login

# Log in and get access tokens

Authenticate a contact with email and password and receive access and refresh tokens.

## Mutation

```graphql
mutation Login($input: LoginInput!) {
  login(input: $input) {
    session {
      accessToken
      refreshToken
    }
  }
}
```

## Variables

```json
{
  "input": {
    "email": "jan@acme.nl",
    "password": "••••••••"
  }
}
```

## Response

```json
{
  "data": {
    "login": {
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
      }
    }
  }
}
```

## How it works

Send the user's credentials to receive a JWT access token and a refresh token. Include the access token in the `Authorization: Bearer <token>` header for subsequent requests. When the access token expires, use the refresh token to obtain a new pair without requiring the user to log in again. The `LoginInput` also accepts an optional `provider` field for external authentication providers. Store tokens securely — never expose them in URLs or local storage accessible to third-party scripts.

## See also

- [Get the logged-in user](/frontend/recipes/get-logged-in-user)
- [Register a new customer or contact](/frontend/recipes/register-customer)

---

## Add or remove a product from a favorite list

URL: https://docs.propeller-commerce.com/frontend/recipes/manage-favorite-list-items

# Add or remove a product from a favorite list

Add products to or remove products from a favorite (wish) list.

## Add products

```graphql
mutation AddToFavoriteList($listId: String!, $input: FavoriteListsItemsInput!) {
  favoriteListAddItems(
    id: $listId
    input: $input
  ) {
    id
    name
    products(input: { offset: 5 }) {
      itemsFound
    }
  }
}
```

### Variables

```json
{
  "listId": "66d6ab6e590599fecc3fa5a2",
  "input": {
    "productIds": [41, 44]
  }
}
```

### Response

```json
{
  "data": {
    "favoriteListAddItems": {
      "id": "66d6ab6e590599fecc3fa5a2",
      "name": "IT supplies afdeling management",
      "products": {
        "itemsFound": 5
      }
    }
  }
}
```

## Remove products

```graphql
mutation RemoveFromFavoriteList($listId: String!, $input: FavoriteListsItemsInput!) {
  favoriteListRemoveItems(
    id: $listId
    input: $input
  ) {
    id
    name
    products(input: { offset: 5 }) {
      itemsFound
    }
  }
}
```

### Variables

```json
{
  "listId": "66d6ab6e590599fecc3fa5a2",
  "input": {
    "productIds": [44]
  }
}
```

### Response

```json
{
  "data": {
    "favoriteListRemoveItems": {
      "id": "66d6ab6e590599fecc3fa5a2",
      "name": "IT supplies afdeling management",
      "products": {
        "itemsFound": 4
      }
    }
  }
}
```

## How it works

Both mutations take the same `FavoriteListsItemsInput` which accepts `productIds` and/or `clusterIds` arrays. You can add or remove multiple products in a single call. The response returns the updated favorite list so you can refresh the product count in the UI. The list `id` is a 12 or 24 character string identifier. To add a cluster (product group) instead of individual products, use `clusterIds` in the input.

## See also

- [Fetch favorite lists with products](/frontend/recipes/fetch-favorite-lists)

---

## Place an order from the cart

URL: https://docs.propeller-commerce.com/frontend/recipes/place-order

# Place an order from the cart

Process the cart into a confirmed order.

## Mutation

```graphql
mutation PlaceOrder($cartId: String!) {
  cartProcess(
    id: $cartId
    input: { orderStatus: "CONFIRMED" }
  ) {
    cartOrderId
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728"
}
```

## Response

```json
{
  "data": {
    "cartProcess": {
      "cartOrderId": "34567"
    }
  }
}
```

## How it works

`cartProcess` converts the cart into an order. The `orderStatus` determines the initial status — use `"CONFIRMED"` for a standard order or `"REQUEST"` for a quote request. The returned `cartOrderId` is the order ID you can use to query the order with `order(orderId: 34567)`. Before calling this mutation, ensure the cart has addresses set, a payment method selected, and at least one item. The optional `language` field controls which language the order confirmation email is sent in.

## See also

- [Set addresses on the cart](/frontend/recipes/set-cart-addresses)
- [Submit a quote request from the cart](/frontend/recipes/submit-quote-request-from-cart)
- [Fetch quote or order detail](/frontend/recipes/fetch-order-detail)

---

## Query products with customer-specific pricing

URL: https://docs.propeller-commerce.com/frontend/recipes/query-products-with-customer-pricing

# Query products with customer-specific pricing

Fetch products showing the price that applies to the logged-in contact's company, including any pricesheet or orderlist pricing.

## Query

When a user is authenticated, the `price` field automatically resolves to the customer-specific price if one exists. No extra parameters are needed — Propeller applies pricesheets based on the session.

```graphql
query GetCustomerPrice($productId: Int!, $taxZone: String!) {
  product(productId: $productId) {
    productId
    sku
    names { language value }
    price(input: { taxZone: $taxZone }) {
      net
      gross
      list
      taxCode
      type
      quantity
    }
  }
}
```

## Variables

```json
{
  "productId": 1895,
  "taxZone": "NL"
}
```

## Response — customer-specific price active

When a pricesheet matches the authenticated user's company, `type` indicates the source:

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" }
      ],
      "price": {
        "net": 907.50,
        "gross": 750.00,
        "list": 899.00,
        "taxCode": "H",
        "type": "PRICESHEET",
        "quantity": 1
      }
    }
  }
}
```

## Response — fallback to default price

When no customer-specific price exists, the default catalog price is returned with `type: "DEFAULT"`:

```json
{
  "data": {
    "product": {
      "productId": 1895,
      "sku": "HP-450G10-I5",
      "names": [
        { "language": "NL", "value": "HP ProBook 450 G10 i5" }
      ],
      "price": {
        "net": 1087.79,
        "gross": 899.00,
        "list": 899.00,
        "taxCode": "H",
        "type": "DEFAULT",
        "quantity": 1
      }
    }
  }
}
```

## How it works

**Authentication drives pricing.** The same query returns different prices depending on the session. An anonymous request gets the default catalog price, while an authenticated request may get a pricesheet price. The `type` field tells you the source: `DEFAULT` = catalog, `PRICESHEET` = company-specific, `BULK_SALES_PRICE` = volume tier. Compare `gross` to `list` to show a "you save X%" indicator.

## See also

- [Fetch a product with pricing](/frontend/recipes/fetch-product-with-pricing)
- [Display tiered and bulk pricing](/frontend/recipes/display-tiered-and-bulk-pricing)

---

## Register a new customer or contact

URL: https://docs.propeller-commerce.com/frontend/recipes/register-customer

# Register a new customer or contact

Register a new contact under an existing company so they can log in and place orders.

## Mutation

```graphql
mutation RegisterContact($input: RegisterContactInput!) {
  contactRegister(input: $input) {
    contact {
      ... on Contact {
        contactId
        firstName
        lastName
        email
      }
    }
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

## Variables

```json
{
  "input": {
    "firstName": "Sophie",
    "lastName": "Bakker",
    "email": "sophie@acme.nl",
    "gender": "F",
    "parentId": 141,
    "password": "••••••••",
    "primaryLanguage": "NL"
  }
}
```

## Response

```json
{
  "data": {
    "contactRegister": {
      "contact": {
        "contactId": 1098,
        "firstName": "Sophie",
        "lastName": "Bakker",
        "email": "sophie@acme.nl"
      },
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refreshToken": "AOEOulYnMD7FqivLPCPy2w3bXn...",
        "expirationTime": "2026-02-25T15:00:00.000Z"
      }
    }
  }
}
```

## How it works

The `parentId` field is required — it links the new contact to an existing company. The `password` field is optional; if omitted, the contact must set a password through the password reset flow. The `gender` field accepts `M`, `F`, or `U` (unknown). The mutation returns a `RegisterContactResponse` with a `contact` field (the `IBaseUser` interface) and a `session` field with access tokens. Use an inline fragment (`... on Contact`) inside `contact` to access the `contactId`. After registration, the contact can log in with the `login` mutation using their email and password.

## See also

- [Log in and get access tokens](/frontend/recipes/login)
- [Get the logged-in user](/frontend/recipes/get-logged-in-user)

---

## Remove an item from the cart

URL: https://docs.propeller-commerce.com/frontend/recipes/remove-cart-item

# Remove an item from the cart

Delete a line item from the cart by its item ID.

## Mutation

```graphql
mutation RemoveCartItem($cartId: String!, $itemId: String!) {
  cartDeleteItem(
    id: $cartId
    input: { itemId: $itemId }
  ) {
    items {
      itemId
      productId
      quantity
    }
    total {
      subTotal
      totalGross
      totalNet
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728",
  "itemId": "019c77b7-72a0-75fe-8a20-b98927d76652"
}
```

## Response

```json
{
  "data": {
    "cartDeleteItem": {
      "items": [],
      "total": {
        "subTotal": 0,
        "totalGross": 355,
        "totalNet": 429.55
      }
    }
  }
}
```

## How it works

Note that `itemId` goes inside the `input` object here, unlike `cartUpdateItem` where it's a top-level argument. When the cart is empty, `totalGross` may still be non-zero due to base shipping costs. The response returns the updated cart so you can refresh the UI immediately.

## See also

- [Update cart item quantity](/frontend/recipes/update-cart-item-quantity)
- [Fetch cart with totals and tax breakdown](/frontend/recipes/fetch-cart-with-totals)

---

## Search categories

URL: https://docs.propeller-commerce.com/frontend/recipes/search-categories

# Search categories

Find categories by parent, name or ID, with pagination and sorting.

## Query

```graphql
query SearchCategories($parentCategoryId: [Int!], $page: Int, $offset: Int) {
  categories(filter: {
    parentCategoryId: $parentCategoryId
    hidden: N
    sortField: name
    sortOrder: ASC
    page: $page
    offset: $offset
  }) {
    itemsFound
    page
    pages
    items {
      categoryId
      name { language value }
      slug { language value }
      hidden
    }
  }
}
```

## Variables

```json
{
  "parentCategoryId": [17],
  "page": 1,
  "offset": 50
}
```

## Response

```json
{
  "data": {
    "categories": {
      "itemsFound": 11,
      "page": 1,
      "pages": 1,
      "items": [
        { "categoryId": 1854, "name": [{ "language": "NL", "value": "Audio en video" }], "slug": [{ "language": "NL", "value": "audio-en-video" }], "hidden": "N" },
        { "categoryId": 1922, "name": [{ "language": "NL", "value": "Gereedschap" }], "slug": [{ "language": "NL", "value": "gereedschap" }], "hidden": "N" },
        { "categoryId": 1794, "name": [{ "language": "NL", "value": "ICT and hardware" }], "slug": [{ "language": "NL", "value": "ict-and-hardware" }], "hidden": "N" }
      ]
    }
  }
}
```

## How it works

The `name` filter is an **exact match** and case-sensitive. Array filters like `categoryId` and `parentCategoryId` use **OR** logic (match any). Different filter fields combine with **AND** logic. Available sort fields: `name`, `dateCreated`, `dateChanged`.

## See also

- [Fetch a category by ID](/frontend/recipes/fetch-category-by-id)
- [Build a category navigation tree](/frontend/recipes/build-category-navigation-tree)

---

## Search products with faceted filters

URL: https://docs.propeller-commerce.com/frontend/recipes/search-products-with-faceted-filters

# Search products with faceted filters

Run a product search with attribute-based filters and return available facets for the UI.

## Step 1 — Fetch available filter facets

First, query the available filters for a category or search result. These facets drive your filter UI.

```graphql
query {
  products(input: {
    categoryId: 1795
  }) {
    itemsFound
    filters(input: { isPublic: true }) {
      id
      attributeDescription { name descriptions { language value } }
      type
      textFilters { value count }
      integerRangeFilter { min max }
      decimalRangeFilter { min max }
    }
  }
}
```

```json
{
  "data": {
    "products": {
      "itemsFound": 42,
      "filters": [
        {
          "id": "a1b2c3d4",
          "attributeDescription": { "name": "BRAND", "descriptions": [{ "language": "NL", "value": "Merk" }] },
          "type": "ENUM",
          "textFilters": [{ "value": "HP", "count": 5 }, { "value": "Lenovo", "count": 4 }, { "value": "Dell", "count": 3 }],
          "integerRangeFilter": null,
          "decimalRangeFilter": null
        },
        {
          "id": "e5f6g7h8",
          "attributeDescription": { "name": "WEIGHT_KG", "descriptions": [{ "language": "NL", "value": "Gewicht" }] },
          "type": "DECIMAL",
          "textFilters": null,
          "integerRangeFilter": null,
          "decimalRangeFilter": { "min": 1.2, "max": 3.8 }
        }
      ]
    }
  }
}
```

Use `attributeDescription.name` as the `name` parameter in `textFilters` or `rangeFilters`. Only attributes with `isSearchable: true` appear as filters.

## Step 2 — Apply text filters

Filter by attribute values like brand or material. Multiple values within a single filter use **OR** logic. Multiple filters use **AND** logic.

```graphql
query {
  products(input: {
    categoryId: 1795
    textFilters: [
      { name: "BRAND", values: ["HP", "Lenovo"] }
    ]
  }) {
    itemsFound
    items {
      ... on Product {
        productId
        names { language value }
        manufacturer
      }
    }
  }
}
```

```json
{
  "data": {
    "products": {
      "itemsFound": 12,
      "items": [
        {
          "productId": 1895,
          "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }],
          "manufacturer": "HP"
        }
      ]
    }
  }
}
```

## Step 3 — Apply range filters

Filter by numeric attributes within a min/max range. Works on `INT` and `DECIMAL` type attributes.

```graphql
query {
  products(input: {
    categoryId: 1795
    textFilters: [
      { name: "BRAND", values: ["HP"] }
    ]
    rangeFilters: [
      { name: "WEIGHT_KG", from: 1.0, to: 2.5 }
    ]
  }) {
    itemsFound
    items {
      ... on Product {
        productId
        names { language value }
      }
    }
  }
}
```

## Step 4 — Apply price range filter

Filter products within a price range. The response includes `minPrice` and `maxPrice` across the result set, useful for rendering price sliders.

```graphql
query {
  products(input: {
    categoryId: 1795
    price: { from: 500, to: 1500 }
  }) {
    itemsFound
    minPrice
    maxPrice
    items {
      ... on Product {
        productId
        names { language value }
        price(input: { taxZone: "NL" }) {
          gross
          net
        }
      }
    }
  }
}
```

```json
{
  "data": {
    "products": {
      "itemsFound": 15,
      "minPrice": 520,
      "maxPrice": 1499,
      "items": [
        {
          "productId": 1895,
          "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }],
          "price": { "gross": 899, "net": 1087.79 }
        }
      ]
    }
  }
}
```

## How it works

- `textFilters` match against product attribute values. The `name` must match an existing `AttributeDescription` name in your system.
- `rangeFilters` work on numeric attributes like weight, length or wattage.
- `price` filters on the calculated product price.
- All filter types combine with **AND** logic — products must match every filter.
- Facets in the response reflect the **current** result set, so they update as filters are applied.

## See also

- [Sort product results](/frontend/recipes/sort-product-results)
- [Fetch a product with pricing](/frontend/recipes/fetch-product-with-pricing)

---

## Search products with a text query

URL: https://docs.propeller-commerce.com/frontend/recipes/search-products-with-text-query

# Search products with a text query

Search across product names, descriptions, SKUs and other text fields.

## Query

```graphql
query SearchProducts($term: String!, $language: String!, $page: Int, $offset: Int) {
  products(input: {
    term: $term
    language: $language
    page: $page
    offset: $offset
  }) {
    itemsFound
    page
    pages
    items {
      ... on Product {
        productId
        sku
        names { language value }
        manufacturer
      }
      ... on Cluster {
        clusterId
        names { language value }
      }
    }
  }
}
```

## Variables

```json
{
  "term": "laptop",
  "language": "NL",
  "page": 1,
  "offset": 12
}
```

## Response

```json
{
  "data": {
    "products": {
      "itemsFound": 5,
      "page": 1,
      "pages": 1,
      "items": [
        {
          "productId": 1895,
          "sku": "HP-450G10-I5",
          "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }],
          "manufacturer": "HP"
        },
        {
          "productId": 1920,
          "sku": "LN-T14S-G4",
          "names": [{ "language": "NL", "value": "Lenovo ThinkPad T14s Gen 4" }],
          "manufacturer": "Lenovo"
        }
      ]
    }
  }
}
```

## How it works

The `language` variable determines which localized content is searched. Results include both Products and Clusters — use inline fragments (`... on Product`, `... on Cluster`) to access type-specific fields. To limit results to one type, add `class: PRODUCT` or `class: CLUSTER` to the input. There is no separate `clusters` query — always use `products` with `class: CLUSTER` to search clusters.

## See also

- [Search products with faceted filters](/frontend/recipes/search-products-with-faceted-filters)
- [Sort product results](/frontend/recipes/sort-product-results)

---

## Set addresses on the cart

URL: https://docs.propeller-commerce.com/frontend/recipes/set-cart-addresses

# Set addresses on the cart

Set the invoice and delivery addresses on the cart before checkout.

## Mutation

```graphql
mutation SetCartAddress($cartId: String!, $input: CartUpdateAddressInput!) {
  cartUpdateAddress(
    id: $cartId
    input: $input
  ) {
    invoiceAddress {
      firstName
      lastName
      company
      street
      number
      postalCode
      city
      country
      email
    }
    deliveryAddress {
      firstName
      lastName
      company
      street
      number
      postalCode
      city
      country
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728",
  "input": {
    "type": "INVOICE",
    "firstName": "Jan",
    "lastName": "de Vries",
    "company": "Acme Industrial B.V.",
    "street": "Industrieweg",
    "number": "42",
    "postalCode": "1234 AB",
    "city": "Amsterdam",
    "country": "NL",
    "email": "jan@acme.nl"
  }
}
```

## Response

```json
{
  "data": {
    "cartUpdateAddress": {
      "invoiceAddress": {
        "firstName": "Jan",
        "lastName": "de Vries",
        "company": "Acme Industrial B.V.",
        "street": "Industrieweg",
        "number": "42",
        "postalCode": "1234 AB",
        "city": "Amsterdam",
        "country": "NL",
        "email": "jan@acme.nl"
      },
      "deliveryAddress": {
        "firstName": "",
        "lastName": "",
        "company": "",
        "street": "",
        "number": "",
        "postalCode": "",
        "city": "",
        "country": "NL"
      }
    }
  }
}
```

## How it works

Call this mutation once for `INVOICE` and once for `DELIVERY` — the `type` field in the input determines which address is set. Required fields are `firstName`, `lastName`, `street`, `postalCode`, `city`, and `country`. The response always returns both addresses so you can confirm the current state. If the delivery address should match the invoice address, send both calls with the same data.

## See also

- [Fetch cart with totals and tax breakdown](/frontend/recipes/fetch-cart-with-totals)
- [Place an order from the cart](/frontend/recipes/place-order)

---

## Sort product results

URL: https://docs.propeller-commerce.com/frontend/recipes/sort-product-results

# Sort product results

Control the ordering of product search results.

## Query

```graphql
query SortProducts($sortField: ProductSortField!, $sortOrder: SortOrder!) {
  products(input: {
    sortInputs: [
      { field: $sortField, order: $sortOrder }
    ]
  }) {
    itemsFound
    items {
      ... on Product {
        productId
        names { language value }
        price(input: { taxZone: "NL" }) { gross }
      }
    }
  }
}
```

## Variables

```json
{
  "sortField": "PRICE",
  "sortOrder": "ASC"
}
```

## Response

```json
{
  "data": {
    "products": {
      "itemsFound": 467,
      "items": [
        {
          "productId": 3201,
          "names": [{ "language": "NL", "value": "Kabelbinder 200mm" }],
          "price": { "gross": 0.45 }
        },
        {
          "productId": 1895,
          "names": [{ "language": "NL", "value": "HP ProBook 450 G10 i5" }],
          "price": { "gross": 899 }
        }
      ]
    }
  }
}
```

## How it works

Available sort fields: `SKU`, `SUPPLIER_CODE`, `CREATED_AT`, `LAST_MODIFIED_AT`, `NAME`, `SHORT_NAME`, `PRICE`, `RELEVANCE`, `CATEGORY_ORDER`, `PRIORITY`. When using `term` for a text search, `RELEVANCE` ranks by match quality. You can pass multiple sort inputs for tie-breaking.

## See also

- [Search products with a text query](/frontend/recipes/search-products-with-text-query)
- [Search products with faceted filters](/frontend/recipes/search-products-with-faceted-filters)

---

## Submit a quote request from the cart

URL: https://docs.propeller-commerce.com/frontend/recipes/submit-quote-request-from-cart

# Submit a quote request from the cart

Convert the current cart into an RFQ so the sales team can respond with custom pricing.

## Mutation

```graphql
mutation SubmitQuoteRequest($cartId: String!) {
  cartProcess(
    id: $cartId
    input: { orderStatus: "REQUEST" }
  ) {
    cartOrderId
  }
}
```

## Variables

```json
{
  "cartId": "018dcc9a-f965-7434-8fad-369aa9a8c276"
}
```

## Response

```json
{
  "data": {
    "cartProcess": {
      "cartOrderId": "34564"
    }
  }
}
```

## How it works

`cartProcess` converts the cart into an order-like entity. Using `orderStatus: "REQUEST"` creates a quote request instead of a regular order. The returned `cartOrderId` is the quote ID. You can set a reference and notes on the cart with `cartUpdate` before submitting. Quote requests appear in the order listing and can be queried with `orders(input: { type: [dropshipment], status: ["REQUEST"] })`.

## See also

- [Cart management](/frontend/domain-guides/cart-and-checkout/cart-management) — building the cart before submitting a quote

---

## Update a channel

URL: https://docs.propeller-commerce.com/frontend/recipes/update-a-channel

# Update a channel

Change the name, catalog root or other settings of an existing channel.

## Mutation

```graphql
mutation UpdateChannel($id: Int!, $input: ChannelUpdateInput!) {
  channelUpdate(id: $id, input: $input) {
    channelId
    name
    catalogRootId
    anonymousUserId
  }
}
```

## Variables

```json
{
  "id": 72,
  "input": {
    "name": "Dealer Portal Germany",
    "catalogRootId": 3000
  }
}
```

## Response

```json
{
  "data": {
    "channelUpdate": {
      "channelId": 72,
      "name": "Dealer Portal Germany",
      "catalogRootId": 3000,
      "anonymousUserId": 14551
    }
  }
}
```

## How it works

Only the fields you include in the input are updated. Pass the channel ID as `$id` and the fields to change in `$input`. The mutation returns the full channel object so you can verify the update in a single round trip.

## See also

- [List channels](/frontend/recipes/list-channels) — retrieve all configured channels
- [Create a channel](/frontend/recipes/create-a-channel) — add a new channel
- [Delete a channel](/frontend/recipes/delete-a-channel) — remove a channel

---

## Update a product

URL: https://docs.propeller-commerce.com/frontend/recipes/update-a-product

# Update a product

Update a product's name, description, status, SKU and other fields using the GraphQL API. Only the fields you include in the input are updated; all other fields remain unchanged.

## Mutation

```graphql
mutation UpdateProduct($productId: Int!, $input: UpdateProductInput!) {
  productUpdate(productId: $productId, input: $input) {
    productId
    names(language: "NL") { value }
    descriptions(language: "NL") { value }
    sku
    status
    manufacturer
    manufacturerCode
    supplier
    supplierCode
    barCode
    eanCode
    minimumQuantity
    unit
    lastModifiedAt
  }
}
```

## Variables

```json
{
  "productId": 26,
  "input": {
    "names": [
      { "language": "NL", "value": "Industriële Kachel HT-350" }
    ],
    "descriptions": [
      { "language": "NL", "value": "<p>Industriële kachel met bovenuitlaat rookkanaal, geschikt voor grote ruimtes.</p>" }
    ],
    "sku": "HT-350-V2",
    "status": "A",
    "manufacturer": "HeatTech",
    "manufacturerCode": "HT350"
  }
}
```

## Response

```json
{
  "data": {
    "productUpdate": {
      "productId": 26,
      "names": [{ "value": "Industriële Kachel HT-350" }],
      "descriptions": [{ "value": "<p>Industriële kachel met bovenuitlaat rookkanaal, geschikt voor grote ruimtes.</p>" }],
      "sku": "HT-350-V2",
      "status": "A",
      "manufacturer": "HeatTech",
      "manufacturerCode": "HT350",
      "supplier": "Ingram Micro",
      "supplierCode": "IM-HT350",
      "barCode": null,
      "eanCode": "8710000000123",
      "minimumQuantity": 1,
      "unit": 1,
      "lastModifiedAt": "2026-03-05T10:15:00.000Z"
    }
  }
}
```

## Common update scenarios

### Change product status

```json
{
  "productId": 26,
  "input": {
    "status": "S"
  }
}
```

### Update SEO metadata

```json
{
  "productId": 26,
  "input": {
    "metadataTitles": [
      { "language": "NL", "value": "Industriële Kachel HT-350 | Online bestellen" }
    ],
    "metadataDescriptions": [
      { "language": "NL", "value": "Industriële kachel met bovenuitlaat rookkanaal, geschikt voor grote ruimtes." }
    ]
  }
}
```

### Set ordering constraints

```json
{
  "productId": 26,
  "input": {
    "minimumQuantity": 5,
    "economicOrderQuantity": 10,
    "orderable": "Y",
    "orderableFrom": "2026-04-01T00:00:00.000Z"
  }
}
```

## Product statuses

| Status | Meaning |
|--------|---------|
| `A` | Active, visible and orderable |
| `N` | New, being set up, not yet live |
| `P` | Pending, awaiting approval |
| `S` | Suspended, temporarily unavailable |
| `R` | Reserved |
| `T` | Terminated, end of life |

## How it works

The `productUpdate` mutation accepts a `productId` and an `UpdateProductInput`. Only fields present in the input object are updated. Localized fields (`names`, `descriptions`, `shortDescriptions`, etc.) accept an array of `{ language, value }` objects. HTML is supported in `descriptions` and `shortDescriptions`. The mutation returns the full product, so you can verify the update in a single round trip.

## See also

- [Fetch product by ID](/frontend/recipes/fetch-product-by-id) — retrieve a product before updating
- [Create a product (REST)](/integrations/recipes/create-a-product) — create new products using the REST API
- [Update a product by lookup key (REST)](/integrations/recipes/update-a-product-by-lookup-key) — update products by SKU or source ID using the REST API

---

## Update cart item quantity

URL: https://docs.propeller-commerce.com/frontend/recipes/update-cart-item-quantity

# Update cart item quantity

Change the quantity of an existing line item in the cart.

## Mutation

```graphql
mutation UpdateCartItem($cartId: String!, $itemId: String!, $quantity: Int!) {
  cartUpdateItem(
    id: $cartId
    itemId: $itemId
    input: { quantity: $quantity }
  ) {
    items {
      itemId
      productId
      quantity
      price
      priceNet
      totalPrice
      totalPriceNet
    }
    total {
      subTotal
      totalGross
      totalNet
    }
  }
}
```

## Variables

```json
{
  "cartId": "019c77b7-565f-7ea0-8660-42bc63a7f728",
  "itemId": "019c77b7-72a0-75fe-8a20-b98927d76652",
  "quantity": 5
}
```

## Response

```json
{
  "data": {
    "cartUpdateItem": {
      "items": [
        {
          "itemId": "019c77b7-72a0-75fe-8a20-b98927d76652",
          "productId": 25,
          "quantity": 5,
          "price": 1595.04,
          "priceNet": 1929.99,
          "totalPrice": 7975.20,
          "totalPriceNet": 9649.99
        }
      ],
      "total": {
        "subTotal": 7975.20,
        "totalGross": 8310.20,
        "totalNet": 10055.34
      }
    }
  }
}
```

## How it works

The `itemId` is a top-level argument, not part of the `input` object. Setting `quantity` to 0 does not remove the item — use `cartDeleteItem` for that. The response returns the full updated cart so you can refresh totals in one round trip. Products with `minimumQuantity` or `purchaseUnit` constraints will reject invalid quantities.

## See also

- [Remove an item from the cart](/frontend/recipes/remove-cart-item)
- [Fetch cart with totals and tax breakdown](/frontend/recipes/fetch-cart-with-totals)

---

## Upload product images

URL: https://docs.propeller-commerce.com/frontend/recipes/upload-product-images

# Upload product images

Attach images to a product, cluster or category using the GraphQL API. Supports uploading from a URL or base64-encoded data.

## Mutation

```graphql
mutation CreateMediaImage($input: MediaImageInput!) {
  mediaImageCreate(input: $input) {
    id
    productId
    alt { language value }
    description { language value }
    priority
    createdAt
  }
}
```

## Variables

```json
{
  "input": {
    "productId": "26",
    "alt": [
      { "language": "EN", "value": "Industriële Kachel HT-350 front view" },
      { "language": "NL", "value": "Industriële Kachel HT-350 vooraanzicht" }
    ],
    "description": [
      { "language": "EN", "value": "Product photo showing the front of the HT-350 industrial heater" },
      { "language": "NL", "value": "Productfoto met de voorkant van de HT-350 industriële kachel" }
    ],
    "tags": [
      { "language": "NL", "values": ["voorkant", "hoofdfoto"] }
    ],
    "priority": 1,
    "uploadImages": [
      {
        "uploadType": "URL",
        "urlFile": {
          "url": "https://example.com/images/ht-350-front.jpg",
          "fileName": "ht-350-front.jpg"
        }
      }
    ]
  }
}
```

## Response

```json
{
  "data": {
    "mediaImageCreate": {
      "id": "66d6ab6e590599fecc3fa5a2",
      "productId": "26",
      "alt": [{ "language": "NL", "value": "Industriële Kachel HT-350 vooraanzicht" }],
      "description": [{ "language": "NL", "value": "Productfoto met de voorkant van de HT-350 industriële kachel" }],
      "priority": 1,
      "createdAt": "2026-03-05T10:00:00.000Z"
    }
  }
}
```

### Upload from base64

For images stored as binary data in a PIM or DAM, use the `BASE64` upload type:

```json
{
  "input": {
    "productId": "26",
    "alt": [{ "language": "NL", "value": "Zijaanzicht" }],
    "description": [{ "language": "NL", "value": "Zijaanzicht productfoto" }],
    "tags": [{ "language": "NL", "values": ["zijkant"] }],
    "priority": 2,
    "uploadImages": [
      {
        "uploadType": "BASE64",
        "base64File": {
          "base64": "iVBORw0KGgo...",
          "fileName": "ht-350-side.png"
        }
      }
    ]
  }
}
```

## Upload types

| Type | Input field | Use case |
|------|------------|----------|
| `URL` | `urlFile` | Image hosted at a public URL (CDN, DAM system) |
| `BASE64` | `base64File` | Binary image data encoded as base64 |
| `FILE` | `file` | Standard file upload (multipart form) |

## Attaching to other entities

Replace `productId` with the appropriate field to attach media to other entities:

| Field | Entity |
|-------|--------|
| `productId` | Product |
| `clusterId` | Cluster |
| `categoryId` | Category |

## How it works

The `priority` field controls display order (lower numbers appear first). Use `alt` for accessibility text and `description` for longer captions. Both `alt` and `description` are localized. The `tags` field accepts arrays of values per language, useful for filtering or grouping images (e.g. "lifestyle", "technical", "packaging"). You can upload multiple images in a single call by adding more entries to the `uploadImages` array.

## See also

- [Add product video](/frontend/recipes/add-product-video) — attach a video to a product
- [Get product images with responsive transformations](/frontend/recipes/get-product-images-with-transformations) — fetch and resize images on the storefront

---

## Accelerator

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/accelerator

# Accelerator


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


**Packages:** `@propeller/accelerator-nextjs` (git clone), `@propeller/accelerator-vue` (coming)

The Accelerator is a complete working storefront application. Clone the repository, configure your API keys and CMS, customize the styling and pages, and you have a production-ready storefront.

This is Layer 3 of the [Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk). It uses [SDK Services](/frontend/storefront-sdk/sdk-services) (Layer 1) and [UI Components](/frontend/storefront-sdk/ui-components) (Layer 2) internally. It adds routing, page templates, CMS integration, state management and configuration on top of those layers.

The Accelerator is the recommended starting point for [Pattern A: Commerce-led](/frontend/storefront-sdk/choosing-your-approach#pattern-a-commerce-led-accelerator) projects.

## What the Accelerator adds on top of Layer 2

| Feature | What it provides |
|---|---|
| **Routing** | File-system routing with commerce routes + CMS catch-all |
| **URL customization** | Change URL patterns in one config file (e.g. `/category/` to `/categorie/`) |
| **CMS integration** | Adapter pattern — swap your CMS by changing one file |
| **Bridge blocks** | Components that combine CMS editorial data with SDK commerce data |
| **State management** | Authentication, cart and global CMS data contexts |
| **Page templates** | Pre-built pages: product detail, category listing, search, cart, checkout, account |
| **Configuration** | Feature flags, pagination defaults, search settings, cache behavior |

## State management

The Accelerator provides three contexts (React) / stores (Vue):

| Context | What it holds |
|---|---|
| `AuthContext` | Access + refresh tokens, user state, auto-logout after inactivity |
| `CartContext` | Cart data with cross-tab synchronization |
| `GlobalContext` | CMS-provided global data (logo, navigation, footer) |

## Configuration

| File | What you configure |
|---|---|
| `.env` | API URLs, API keys, CMS credentials |
| `data/config.ts` | URL patterns, feature flags, URL builder functions, base category ID |
| `lib/cms/index.ts` | CMS provider choice |
| `data/defaults.ts` | Pagination, search, cart behavior, validation, timeouts |
| `components/cms/DynamicBlockRenderer.tsx` | Block type to component mappings |

## Authentication

The Accelerator handles customer authentication client-side. There is no server-side middleware for customer auth.

**Token management** — login returns an access token and a refresh token. Both are stored in localStorage via `AuthContext`. The access token is included in SDK requests through the [GraphQL proxy](/frontend/storefront-sdk/sdk-services#graphql-proxy-pattern), which forwards the authorization header to Propeller's API.

**Session timeout** — `AuthContext` tracks user activity and automatically logs out after 30 minutes of inactivity.

**Protected routes** — account pages (`/account/*`) are guarded by a layout component (`account/layout.tsx`) that checks for a valid session. Unauthenticated users are redirected to the login page.

See [Authentication and authorization](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization) for the underlying GraphQL mutations for login, registration and token refresh.

## What works without a CMS

All commerce pages work without any CMS connected:

| Page | Without CMS |
|---|---|
| Product pages | Fully driven by SDK |
| Category pages | Fully driven by SDK (banner slot stays empty) |
| Search, cart, checkout, account | Zero CMS dependency |
| Home page | Falls back to showing categories and products from SDK |
| CMS content pages | Not available (404) |

## See also

- [CMS Integration](/frontend/storefront-sdk/cms-integration) — the adapter pattern and bridge blocks
- [Routing](/frontend/storefront-sdk/routing) — how commerce routes and CMS routes are configured
- [Customization](/frontend/storefront-sdk/customization) — callbacks, pass-through properties and override patterns
- [Clone and Run](/getting-started/build-a-frontend/using-the-storefront-sdk/clone-and-run) — set up the Accelerator locally

---

## B2B Capabilities

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/b2b-capabilities

# B2B Capabilities


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


The SDK and UI components are built for B2B commerce, not just B2C. Several features reflect this across all three layers.

## Portal modes

Components support two visibility modes via the `portalMode` prop:

| Mode | Behavior |
|---|---|
| `open` | Full e-commerce. Prices visible. Add-to-cart enabled. |
| `semi-closed` | Catalog-only. Prices and add-to-cart hidden for unauthenticated users. Price filtering and price-based sorting disabled. |

This is useful for B2B scenarios where pricing is customer-specific and should only be shown after login. Components that respect portal mode include [`ProductGrid`](/reference/storefront-sdk/product-display/product-grid) (hides [`AddToCart`](/reference/storefront-sdk/cart-and-checkout/add-to-cart)), [`GridFilters`](/reference/storefront-sdk/navigation-and-search/grid-filters) (hides price filter) and GridToolbar (disables price sorting).

## Contact-company model

The SDK supports the Propeller data model where Contacts belong to Companies, and Companies have associated price sheets, order lists and addresses. The `UserService` handles registration with before/after callbacks, enabling partners to:

- Assign a new contact to a company
- Link the contact to a price sheet
- Add the contact to an order list as part of the registration flow

See [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) for the underlying data model.

## Clusters

Propeller's product model supports clusters (configurable product groups with variants). The SDK and components handle both standalone products and clusters, including cluster options (add-on product groups like insurance or accessories).

The [`ClusterCard`](/reference/storefront-sdk/clusters/cluster-card) component handles cluster display, variant selection and option configuration.

See [Understanding products and categories](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories) for how clusters work in the data model.

## Customer-specific pricing

The SDK handles customer-specific pricing through Propeller's price sheet system. When a user is authenticated, the [GraphQL proxy](/frontend/storefront-sdk/sdk-services#graphql-proxy-pattern) forwards their authorization header, and the API returns prices specific to their company's price sheet.

In `semi-closed` portal mode, unauthenticated users see the product catalog without prices. After login, customer-specific prices are displayed automatically.

See [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) for how price sheets and action codes work.

## See also

- [SDK Services](/frontend/storefront-sdk/sdk-services) — the typed services that power B2B features
- [UI Components](/frontend/storefront-sdk/ui-components) — components that support portal modes and clusters
- [Understanding companies, contacts and customers](/frontend/domain-guides/accounts-and-authentication/understanding-companies-contacts-and-customers) — the B2B data model
- [Customer-specific pricing](/frontend/domain-guides/pricing-and-discounts/customer-specific-pricing) — price sheets and action codes

---

## Choosing Your Approach

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/choosing-your-approach

# Choosing Your Approach


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


Partners building on Propeller come from different starting points. Some are building a new storefront from scratch. Others have an existing website on a CMS platform with its own frontend framework. Some manage multiple brands and sites from one CMS.

The Storefront SDK's [three-layer architecture](/frontend/storefront-sdk/understanding-the-storefront-sdk) supports three common patterns. Choose the one that fits your project.

## Pattern A: Commerce-led (Accelerator)

The Accelerator owns routing. Commerce pages (product, category, cart, checkout, account) are file-system routes. The CMS handles content pages via a catch-all route.

```
Propeller Accelerator (owns routing)
├── /product/42/shoes        → ProductService
├── /category/17/electronics → CategoryService
├── /cart, /checkout         → CartService
├── /account/*               → UserService
└── /about-us, /blog/*       → CMS catch-all
```

**Uses:** Layer 3 ([Accelerator](/frontend/storefront-sdk/accelerator)), which includes Layer 2 ([UI Components](/frontend/storefront-sdk/ui-components)) and Layer 1 ([SDK Services](/frontend/storefront-sdk/sdk-services)).

**Best for:** greenfield projects where speed to market is the priority and content needs are straightforward. The Accelerator provides a working storefront out of the box.

## Pattern B: CMS-led

The CMS owns all pages, all URLs and all routing. Commerce components are functional blocks injected into CMS-managed page templates. Page structure is fully configurable in the CMS.

```
CMS (owns routing and page structure)
├── /                        → CMS page with commerce blocks
├── /products/shoes          → CMS page with ProductGrid block
├── /products/shoes/nike-42  → CMS page with ProductDetail block
├── /about-us                → CMS page (editorial only)
└── /cart                    → CMS page with Cart block
```

**Uses:** Layer 1 ([SDK Services](/frontend/storefront-sdk/sdk-services)) + Layer 2 ([UI Components](/frontend/storefront-sdk/ui-components)). The partner imports SDK services and UI components into their CMS's frontend framework and handles routing through the CMS.

**Best for:** multi-brand and multi-site environments where content editors need to manage everything from one place.

## Pattern C: SDK-only with custom UI

The partner uses SDK services directly and builds all UI themselves. No Propeller-provided components. The [stack-agnostic component documentation](/frontend/storefront-sdk/ui-components#stack-agnostic-component-documentation) serves as a reference for what to build and which SDK methods to call.

**Uses:** Layer 1 ([SDK Services](/frontend/storefront-sdk/sdk-services)) only.

**Best for:** partners with strict architectural requirements, a framework without Propeller component support, or a need for full control over every aspect of the frontend.

## Decision table

| Your situation | Recommended approach |
|---|---|
| You have an existing frontend and just need Propeller data | **Layer 1 (SDK only)** — import `propeller-sdk-v2`, use the typed services |
| You want pre-built commerce components in your existing React or Vue project | **Layer 1 + 2** — install `@propeller/ui-react` or `@propeller/ui-vue` via npm |
| You want a working storefront out of the box | **Layer 3 (Accelerator)** — clone the Next.js or Vue app and customize |
| Your CMS owns routing and page structure | **Layer 1 + 2** — use SDK and components, let your CMS handle pages and URLs (Pattern B) |
| You manage multiple brands or sites from one CMS | **Layer 1 + 2** — CMS-led architecture where all pages and URLs are managed centrally |
| You use a framework we don't have components for (Angular, Svelte, Web Components, etc.) | **Layer 1 + component docs** — use the SDK directly and build UI from the stack-agnostic component documentation |
| You want to prototype or demo quickly for pre-sales | **Layer 3 (Accelerator)** — fastest path to a working storefront |
| You need a B2B portal with customer-specific pricing | **Any layer** — use `semi-closed` portal mode to hide prices for unauthenticated users |

## Next steps

- [SDK Services](/frontend/storefront-sdk/sdk-services) — deep dive into Layer 1
- [UI Components](/frontend/storefront-sdk/ui-components) — deep dive into Layer 2
- [Accelerator](/frontend/storefront-sdk/accelerator) — deep dive into Layer 3

---

## CMS Integration

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/cms-integration

# CMS Integration


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


CMS integration works differently depending on which [approach](/frontend/storefront-sdk/choosing-your-approach) you use:

| Approach | CMS role |
|---|---|
| **[Pattern A](/frontend/storefront-sdk/choosing-your-approach#pattern-a-commerce-led-accelerator) (Accelerator)** | The Accelerator owns routing. The CMS handles content pages via a catch-all route. This is what the adapter pattern below describes. |
| **[Pattern B](/frontend/storefront-sdk/choosing-your-approach#pattern-b-cms-led) (CMS-led)** | The CMS owns all pages, URLs and routing. You import [SDK Services](/frontend/storefront-sdk/sdk-services) and [UI Components](/frontend/storefront-sdk/ui-components) into your CMS's frontend framework. The adapter pattern is not needed because your CMS handles content directly. |
| **[Pattern C](/frontend/storefront-sdk/choosing-your-approach#pattern-c-sdk-only-with-custom-ui) (SDK-only)** | No CMS involvement. You handle content in your own code. |

The rest of this page describes how CMS integration works in the [Accelerator](/frontend/storefront-sdk/accelerator) (Pattern A). Strapi is the default CMS. Partners using a different CMS can write their own adapter.

## The adapter pattern

The Accelerator uses a CMS adapter pattern so that page templates and CMS block components never depend on a specific CMS. Three packages make this work:

| Package | Purpose |
|---------|---------|
| `@propeller/cms-core` | Unified TypeScript interfaces (`CmsProvider`, `CmsPage`, `CmsBlock`, `CmsImage`). Accelerator page templates and CMS block components depend on these types. |
| `@propeller/cms-strapi` | Strapi adapter with normalizers that transform Strapi responses into the unified types. This is the default. |

<!-- TODO: Confirm package names are final and published to npm -->

Partners pick their CMS by changing a single file:

```ts
// lib/cms/index.ts


export const cmsProvider = createStrapiProvider({
  apiUrl: '...',
  apiToken: '...',
});
```

To switch to a different CMS, only this file changes. No components, routing config or templates need to change.

## Writing a custom adapter

If your project uses a CMS other than Strapi, you implement the interfaces defined in `@propeller/cms-core`. Your adapter normalizes your CMS's response format into the unified types that the Accelerator's page templates and CMS block components expect.

<!-- TODO: Link to CmsProvider interface reference once available. Add example of a minimal custom adapter. -->

## CMS block components

CMS block components live in the Accelerator, not in the [UI Components](/frontend/storefront-sdk/ui-components) library. They are distinct from the SDK-only UI components described in Layer 2.

CMS block components receive data through the unified `CmsPage` and `CmsBlock` types. A `HeroBanner` block component does not know which CMS is behind the adapter. It receives a block object with fields like `image`, `title` and `categoryId`, and renders them.

This separation means you can evaluate or switch CMS platforms without rewriting your Accelerator's CMS block components.

## Bridge blocks

Bridge blocks are the key pattern for combining CMS content with commerce data. A bridge block is a component that:

1. Receives editorial data from the CMS (an image, a category ID, a text block)
2. Fetches commerce data from the Propeller SDK (category name, product list, pricing)
3. Renders both together

For example, an editor sets `categoryId: 17` and uploads a banner image in the CMS. The bridge block component fetches the category name and slug from the Propeller API, then renders the banner image alongside the category title with a link to the category page.

## Dynamic block rendering

CMS pages are built from blocks (called Dynamic Zones in Strapi). The Accelerator includes a `DynamicBlockRenderer` that maps each block type to a component:

| Block type | Component |
|------------|-----------|
| `hero-banner` | `HeroBanner` |
| `rich-text` | `RichText` |
| `category-banner` | `CategoryBanner` |
| `product-carousel` | `ProductCarousel` |

<!-- TODO: Confirm the full list of supported block types -->

When you create custom block types in your CMS, you add the mapping in `components/cms/DynamicBlockRenderer.tsx`.

<!-- TODO: Add code example showing how to register custom block types in DynamicBlockRenderer -->

## Site-wide CMS data

The header, footer and navigation links are managed in the CMS under a global configuration (a "single type" in Strapi). The root `layout.tsx` calls `getGlobal()` on every request and makes the result available to all pages through a `GlobalProvider`.

When a CMS is connected, global data (logo, navigation, footer) is fetched for every page, including commerce pages. When no CMS is configured, `getGlobal()` returns null and the application renders without CMS data.

## See also

- [Routing](/frontend/storefront-sdk/routing) for how CMS routes and commerce routes are resolved
- [Accelerator](/frontend/storefront-sdk/accelerator) for how the CMS layer fits into the Accelerator
- [Choosing Your Approach](/frontend/storefront-sdk/choosing-your-approach) for the three common partner architectures

---

## Customization

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/customization

# Customization


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


The Storefront SDK is designed to be customized. Components expose callbacks and pass-through properties that let you add custom behavior without forking the component source.

## Component callbacks

Components expose callbacks that fire before, during or after key actions. You provide your own function and the component calls it at the right moment.

Common callback patterns:

| Callback | Fires when | Returns |
|----------|-----------|---------|
| `onCartCreated` | A new cart is created | The new cart object |
| `afterRegister` | A new user registers | The user object |

<!-- TODO: Confirm the full list of callbacks once component docs are finalized -->

Use callbacks to inject custom business logic. For example, after user registration you might need to add the new contact to an order list or set a specific attribute value. Override the `afterRegister` callback to add that logic while still using the default registration component.

## Pass-through properties

When components are nested (like [`AddToCart`](/reference/storefront-sdk/cart-and-checkout/add-to-cart) inside [`ProductCard`](/reference/storefront-sdk/product-display/product-card)), the parent exposes pass-through properties for the child. This means you provide child component properties directly on the parent, and the parent forwards them.

For example, `ProductCard` accepts all `AddToCart` properties (`cartId`, `createCart`, `onCartCreated`) in addition to its own properties. The component documentation for each parent lists which properties are its own and which are forwarded.

This pattern means you do not need to access child components directly. You configure everything from the outermost component.

## Overriding default behavior

Components that require API access handle it by default. If you need different behavior, you can use before/after actions (hooks that fire before or after a default action) and override the default callback to inject custom logic.

<!-- TODO: Add code examples showing a callback override once component API is stable. Confirm the full override mechanism and what can be overridden per component. -->

## Theming

<!-- TODO: Add theming details once the approach is documented. Covers CSS customization, design tokens or component styling approach. -->

Theming and visual customization details will be added once the approach is finalized.

## See also

- [UI Components](/frontend/storefront-sdk/ui-components) for the component inventory, callback pattern and required properties
- [Accelerator](/frontend/storefront-sdk/accelerator) for how components, pages and the SDK layer relate
- [CMS Integration](/frontend/storefront-sdk/cms-integration) for customizing CMS block rendering

---

## Deployment

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/deployment

# Deployment


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


<!-- TODO: Add deployment documentation. Topics to cover: hosting requirements, environment variables for production, build commands, static generation settings, CMS webhook configuration for on-demand revalidation, and recommended hosting platforms. -->

Production deployment guidance for the Storefront SDK will be added here.

---

## Routing

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/routing

# Routing


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


This page describes routing in the [Accelerator](/frontend/storefront-sdk/accelerator) ([Pattern A: Commerce-led](/frontend/storefront-sdk/choosing-your-approach#pattern-a-commerce-led-accelerator)). In a [CMS-led architecture](/frontend/storefront-sdk/choosing-your-approach#pattern-b-cms-led) (Pattern B), the CMS owns all routing and the patterns below do not apply.

The Accelerator splits routing between file-system routes (commerce pages) and the CMS (content pages). A single route config file controls URL patterns for both.

## Route config file

The route config is a single project-wide file that defines URL patterns and CMS settings. Every component that needs URL information receives this config as a property.

```ts
// lib/routing/routes.config.ts
```

<!-- TODO: Add a complete example of the route config file once the format is finalized -->

The config contains:

- **`baseCategoryId`** — the root category ID for your Propeller environment
- **Commerce patterns** for product, category and other commerce URLs
- **CMS patterns** for content pages served by the headless CMS

## Commerce patterns

Commerce patterns define the public URL structure for commerce pages. Each pattern has three fields:

| Field | Description |
|-------|-------------|
| `pattern` | The public URL (e.g. `/product/:id/:slug`) |
| `internal` | The corresponding `app/` folder path in Next.js |
| `source` | Always `'commerce'` for commerce routes |

Partners customize the `pattern` to match their URL strategy. For example, a Dutch storefront might change `/category/:id/:slug` to `/categorie/:id/:slug`. The `next.config.ts` reads the route config and auto-generates Next.js rewrites so the custom URL internally renders the correct page.

This means you change URLs in one place and all components that generate links follow the new pattern.

## CMS patterns

CMS patterns define which URL groups are served by the headless CMS. Each pattern has:

| Field | Description |
|-------|-------------|
| `pattern` | URL pattern with wildcards (e.g. `/blog/**`) |
| `template` | The page template to use (e.g. `blog-post`) |
| `revalidate` | Cache revalidation time in seconds |

A `/**` wildcard acts as a fallback. This means every page created in the CMS is automatically available on the frontend without any config change. Partners only add specific patterns when they need a different template or caching strategy for a group of pages.

## How routes are resolved

Next.js matches routes from most specific to least specific:

1. **Hardcoded commerce routes** are matched first. Pages like `/login`, `/cart`, `/product/[productId]/[slug]` and `/category/[id]/[slug]` are standard Next.js App Router routes with their own `page.tsx` files.

2. **CMS catch-all route** handles everything else. The file `app/(cms)/[...slug]/page.tsx` is a catch-all inside a `(cms)` route group. The `(cms)` prefix is invisible in the URL.

When a request arrives for a URL like `/about-us`:

1. No hardcoded route matches `/about-us`
2. The CMS catch-all receives the request
3. The slug is used to query the CMS for a page matching `about-us`
4. If the CMS has a page, it is rendered using the `DynamicBlockRenderer`
5. If no page is found, a 404 is returned

Commerce routes always take priority over CMS pages. A CMS page cannot override `/cart` or `/login`.

## URL builder utilities

The SDK provides URL builder functions that generate URLs based on the route config:

<!-- TODO: Confirm function signatures and add import examples -->

- `categoryUrl()` generates a category URL from a category object
- `productUrl()` generates a product URL from a product object

These functions read the patterns from the route config, so changing a URL pattern in the config automatically updates all generated links across the application.

## Caching

CMS content caching is configured per route pattern using the `revalidate` field:

- **Development:** `cache: 'no-store'` (always fresh data)
- **Production:** ISR (Incremental Static Regeneration) with a configurable revalidation interval

The CMS also supports on-demand revalidation through webhooks. A `/api/revalidate` endpoint receives webhook calls from the CMS and invalidates the cached page. This endpoint uses `cmsProvider.verifyWebhook()` for security, making it CMS-agnostic.

## Static generation

At build time, `generateStaticParams()` fetches all page slugs from the CMS and pre-renders them as static HTML. The home page is excluded from this list because it is handled by `app/page.tsx`.

## What partners configure

| File | What | How often |
|------|------|-----------|
| `lib/routing/routes.config.ts` | URL patterns, templates, caching | Once at setup, rarely changed |
| `lib/cms/index.ts` | CMS provider choice | Once at setup |
| `.env` | API URLs and tokens | Once at setup |
| `components/cms/DynamicBlockRenderer.tsx` | Custom block type mappings | When adding custom blocks |
| `components/cms/templates/` | Custom page layouts | When adding new layouts |

## See also

- [CMS integration](/frontend/storefront-sdk/cms-integration) for the adapter pattern and bridge blocks
- [Categories and navigation](/frontend/domain-guides/products-and-catalog/categories-and-navigation) for the underlying category data model

---

## SDK Services

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/sdk-services

# SDK Services


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


**Package:** `propeller-sdk-v2` (npm)

The SDK is a TypeScript library that wraps Propeller's GraphQL API into typed service classes. It works in any JavaScript or TypeScript project: Node.js, React, Vue, Angular, Svelte, server-side scripts or anything else.

This is Layer 1 of the [Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk). You can use it on its own or as the foundation for [UI Components](/frontend/storefront-sdk/ui-components) (Layer 2) and the [Accelerator](/frontend/storefront-sdk/accelerator) (Layer 3).

## Services

The SDK provides typed services:

| Service | What it does |
|---|---|
| `ProductService` | Fetch product details, specifications, media, pricing |
| `CategoryService` | Fetch category trees, category products with filtering and pagination |
| `CartService` | Create carts, add/update/remove items, manage addresses |
| `UserService` | User profile, user data |
| `LoginService` | Authentication, login, token management |
| `OrderService` | Order history, order details |
| `PayMethodService` | Available payment methods |
| `MenuService` | Navigation menu structure |
| `AddressService` | Address CRUD operations for contacts, customers and companies |
| `FavoriteListService` | Favorite list management, add/remove items |

Each service provides typed methods with typed inputs and outputs. No manual GraphQL query writing needed.

## Initialization

```typescript

  GraphQLClient,
  ProductService,
  CartService,
  CategoryService,
  UserService,
  LoginService,
  OrderService,
  PayMethodService,
  MenuService,
  AddressService,
  FavoriteListService
} from 'propeller-sdk-v2';

const graphqlClient = new GraphQLClient({
  endpoint: '/api/graphql',
  apiKey: '',                  // handled by server-side proxy
  timeout: 30000,
});

const productService = new ProductService(graphqlClient);
const categoryService = new CategoryService(graphqlClient);
const cartService = new CartService(graphqlClient);
const userService = new UserService(graphqlClient);
const loginService = new LoginService(graphqlClient);
const orderService = new OrderService(graphqlClient);
const payMethodService = new PayMethodService(graphqlClient);
const menuService = new MenuService(graphqlClient);
const addressService = new AddressService(graphqlClient);
const favoriteListService = new FavoriteListService(graphqlClient);
```

## Usage examples

### Fetching a product

```typescript
const product = await productService.getProduct({
  productId: 42,
  language: 'NL',
  imageSearchFilters: { ... },
  imageVariantFilters: { ... },
});

// product.names[0].value      → "Logitech MX Keys"
// product.sku                 → "MXK-001"
// product.price.gross         → 119.00
// product.media.images.items  → [{ imageVariants: [{ url: "..." }] }]
```

### Fetching a category with products

```typescript
const category = await categoryService.getCategory({
  categoryId: 17,
  language: 'NL',
  categoryProductSearchInput: {
    language: 'NL',
    page: 1,
    offset: 12,
    textFilters: [{ name: 'COLOR', values: ['Red'] }],
    sortInputs: [{ field: 'NAME', order: 'ASC' }],
  },
});

// category.products.items      → Product[]
// category.products.itemsFound → 48
// category.products.pages      → 4
// category.products.filters    → AttributeFilter[]
```

### Adding to cart

```typescript
const cart = await cartService.addItemToCart({
  id: cartId,
  input: {
    productId: product.productId,
    quantity: 2,
  },
  language: 'NL',
  imageSearchFilters: { ... },
  imageVariantFilters: { ... },
});
```

## GraphQL proxy pattern

The SDK sends all requests to a server-side API route (`/api/graphql`) rather than directly to Propeller's API. This proxy injects the API key server-side so it is never exposed to the browser.

```
Browser                          Server                    Propeller API
───────                          ──────                    ────────────
productService.getProduct()
  → POST /api/graphql            → Injects API key header
                                  → Forwards to Propeller  → Returns data
                                  ← Passes response back
  ← Receives typed result
```

When a user is logged in, the proxy also forwards the user's authorization header.

## See also

- [UI Components](/frontend/storefront-sdk/ui-components) — pre-built components that use the SDK internally
- [Accelerator](/frontend/storefront-sdk/accelerator) — a full app built on the SDK and UI components
- [B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities) — portal modes, contact-company model and clusters in the SDK
- [Querying products](/frontend/domain-guides/products-and-catalog/querying-products) — the underlying GraphQL queries that SDK services wrap

---

## UI Components

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/ui-components

# UI Components


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


**Packages:** `@propeller/ui-react` (npm), `@propeller/ui-vue` (npm, coming)

Pre-built e-commerce components that use the [SDK](/frontend/storefront-sdk/sdk-services) internally. Install via npm. Use in any React or Vue project without the [Accelerator](/frontend/storefront-sdk/accelerator).

This is Layer 2 of the [Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk). It builds on Layer 1 (SDK Services) and is used by Layer 3 (Accelerator).

## Design principle: SDK-only

UI components talk to Propeller SDK services only. They have **no CMS dependency**. A `ProductCard` fetches product data from the SDK. A `ProductGrid` fetches category data from the SDK. An `AddToCart` component creates and manages carts through the SDK.

CMS content is not baked into the components. Instead, components expose **callbacks and events** where you can inject CMS content, custom logic or framework-specific routing. This keeps the components portable across any project, regardless of which CMS (or no CMS) you use.

## Usage example

```tsx



<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  cartId={cart?.cartId}
  configuration={config}
  showModal={true}
  onProductClick={(p) => router.push(`/product/${p.productId}`)}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

The `onProductClick` callback is where you handle routing. The component does not care whether you use Next.js `router.push`, Vue Router or plain `window.location`. Same for `afterAddToCart`: you decide what happens after an item is added.

## Common component properties

Components receive data and configuration through properties. The most common properties across components are:

| Property | Description |
|----------|-------------|
| `graphqlClient` | A GraphQL client instance. The SDK provides a default client, or you can implement your own. |
| `user` | The current user object from your application state. Components do not manage user state themselves. |
| `product` | The product object (needed for product ID, pricing and other product-level behavior). Used by product-level components like ProductCard and AddToCart. |
| `configuration` | A reference to the global route config file that controls URL patterns and base settings. |

Not every component uses the same set of properties. For example, `ProductGrid` takes a `categoryId` and `graphqlClient` but does not require a `product` prop. The component documentation specifies which properties each component accepts.

## Callback pattern

Components do not own or dictate application state. They follow a callback pattern:

1. A component performs an action (add to cart, login, register)
2. The component calls a callback with the result (the new cart, the user object)
3. Your application stores the result however you choose

This means you are free to use any state management approach: React Context, Zustand, Redux or plain state. See [Customization](/frontend/storefront-sdk/customization) for more on callbacks and override patterns.

## Component inventory

54 components across 7 categories. See the [Storefront SDK reference](/reference/storefront-sdk) for the full per-component API documentation with props, callbacks, labels and behavior.

| Category | Components |
|---|---|
| **[Product Display](/reference/storefront-sdk/product-display)** (17) | ProductCard, ProductGrid, ProductInfo, ProductGallery, ProductPrice, ProductSpecifications, ProductTabs, ProductDescription, ProductShortDescription, ProductDownloads, ProductVideos, ProductBulkPrices, ProductBundles, ProductSlider, ItemStock, ItemsOverview, PriceToggle |
| **[Cart and Checkout](/reference/storefront-sdk/cart-and-checkout)** (9) | AddToCart, CartItem, CartOverview, CartSummary, CartIconAndSidebar, CartCarriers, CartPaymethods, DeliveryDate, ActionCode |
| **[Navigation and Search](/reference/storefront-sdk/navigation-and-search)** (9) | Menu, Breadcrumbs, SearchBar, GridFilters, GridPagination, GridToolbar, GridTitle, CategoryDescription, CategoryShortDescription |
| **[Authentication](/reference/storefront-sdk/authentication)** (7) | LoginForm, RegisterForm, ForgotPassword, AccountIconAndMenu, UserDetails, AddressCard, CompanySwitcher |
| **[Favorites](/reference/storefront-sdk/favorites)** (4) | AddToFavorite, FavoriteLists, FavoriteListDetails, FavoriteListItem |
| **[Orders](/reference/storefront-sdk/orders)** (4) | OrderList, OrderSummary, OrderItemCard, OrderTotals |
| **[Clusters](/reference/storefront-sdk/clusters)** (4) | ClusterCard, ClusterConfigurator, ClusterInfo, ClusterOptions |

## Where CMS content fits

Components do not include CMS content, but many offer natural injection points via callbacks:

| Component | CMS injection point | What you'd inject |
|---|---|---|
| ProductGrid | `onCategoryChange` callback | A category banner image from your CMS |
| Registration form | Before/after registration events | Custom terms and conditions from CMS, post-registration CMS content |
| Header | Logo/navigation props | Logo and nav links managed in your CMS |
| Footer | Content props | Footer columns and links from your CMS |

The [Accelerator](/frontend/storefront-sdk/accelerator) includes working examples of these patterns using Strapi.

## Stack-agnostic component documentation

Every UI component is documented in the [Storefront SDK reference](/reference/storefront-sdk) with two tabs: **React** (pre-built component usage) and **Build Your Own** (SDK service approach for custom implementations). This documentation describes what the component does, its properties, events and SDK usage. It serves two purposes:

1. **Understanding** — you can read the conceptual docs to understand what a component does before looking at framework-specific code.
2. **Building your own** — if you work in a framework Propeller does not provide components for (Angular, Svelte, Web Components, etc.), the conceptual documentation serves as a complete spec to build your own implementation.

### Using component documentation for custom implementations

The stack-agnostic documentation can be used as input for AI-assisted component generation. Partners have demonstrated generating working Next.js and Web Components implementations from the conceptual component descriptions, producing functional prototypes in hours rather than days.

This is particularly useful for:

- **Pre-sales** — rapidly prototype a storefront to demonstrate what is possible, without committing to a framework
- **Non-standard stacks** — when the partner's project uses a framework Propeller does not provide components for, the documentation serves as a complete spec
- **Starting point, not end state** — AI-generated components are useful as accelerators, but production implementations require manual work on deep linking, query parameter handling, URL-friendly filters and edge cases

The component documentation also enables non-technical conversations. Because it describes interaction concepts rather than code, it can be discussed with marketing and product teams.

## Rendering approach

Components are client-side rendered (`'use client'` in Next.js). The Accelerator runs on Next.js, which supports server-side rendering for initial page loads and static generation at the page level, but the UI components themselves execute on the client.

## Component nesting and pass-through properties

When a child component (like `AddToCart`) is embedded in a parent component (like `ProductCard`), the parent exposes pass-through properties. This means you provide `AddToCart` properties directly on `ProductCard`, and `ProductCard` forwards them to its embedded `AddToCart`.

The component documentation for each parent lists which properties are its own and which are forwarded to child components.

## See also

- [SDK Services](/frontend/storefront-sdk/sdk-services) — the typed services that components use internally
- [Accelerator](/frontend/storefront-sdk/accelerator) — the full app that uses these components
- [Customization](/frontend/storefront-sdk/customization) — callbacks, pass-through properties and override patterns
- [B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities) — portal modes and clusters in component context

---

## Understanding the Storefront SDK

URL: https://docs.propeller-commerce.com/frontend/storefront-sdk/understanding-the-storefront-sdk

# Understanding the Storefront SDK


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


The Storefront SDK is a set of packages that help you build customer-facing experiences on Propeller. It is organized in three layers. Each layer builds on the previous one. You pick the level that fits your project.

<div style={{border: '2px solid var(--ifm-color-emphasis-300)', borderRadius: '12px', padding: '20px', marginBottom: '24px'}}>
  <div style={{fontWeight: 700, fontSize: '1.05em', marginBottom: '4px', color: 'var(--ifm-color-primary)'}}>Layer 3: Accelerator</div>
  <div style={{fontSize: '0.9em', color: 'var(--ifm-color-emphasis-700)', marginBottom: '16px'}}>
    Full app with routing, CMS integration and state management. Clone and customize.
  </div>
  <div style={{border: '2px solid var(--ifm-color-emphasis-300)', borderRadius: '10px', padding: '18px'}}>
    <div style={{fontWeight: 700, fontSize: '1.05em', marginBottom: '4px', color: 'var(--ifm-color-primary)'}}>Layer 2: UI Components</div>
    <div style={{fontSize: '0.9em', color: 'var(--ifm-color-emphasis-700)', marginBottom: '16px'}}>
      Pre-built commerce components for React and Vue. Stack-agnostic documentation for building in any framework.
    </div>
    <div style={{border: '2px solid var(--ifm-color-emphasis-300)', borderRadius: '8px', padding: '16px', background: 'var(--ifm-color-emphasis-100)'}}>
      <div style={{fontWeight: 700, fontSize: '1.05em', marginBottom: '4px', color: 'var(--ifm-color-primary)'}}>Layer 1: SDK Services</div>
      <div style={{fontSize: '0.9em', color: 'var(--ifm-color-emphasis-700)'}}>
        Typed TypeScript services. Works in any JavaScript or TypeScript project.
      </div>
    </div>
  </div>
</div>

- **Layer 1 ([SDK Services](/frontend/storefront-sdk/sdk-services))** — you write all your own UI. The SDK gives you typed services to talk to Propeller's GraphQL API. Works in any JavaScript or TypeScript project.
- **Layer 2 ([UI Components](/frontend/storefront-sdk/ui-components))** — ready-made e-commerce components on top of the SDK. Available for React and Vue via npm. Each component also has stack-agnostic documentation that serves as a complete spec, so partners can build their own implementation in any framework.
- **Layer 3 ([Accelerator](/frontend/storefront-sdk/accelerator))** — you get a complete working storefront. Clone it, customize it, launch. Includes routing, CMS integration and all Layer 2 components pre-wired. Available as a Next.js app (`@propeller/accelerator-nextjs`), with a Vue version coming.

Each layer is **independently usable**. You do not need Layer 3 to use Layer 2. You do not need Layer 2 to use Layer 1.

## Packages

| Package | What it is | Distribution |
|---|---|---|
| `propeller-sdk-v2` | TypeScript SDK — services, types, GraphQL client | npm |
| `@propeller/ui-react` | React UI components | npm |
| `@propeller/ui-vue` | Vue UI components (coming) | npm |
| `@propeller/cms-core` | CMS adapter interfaces | npm |
| `@propeller/cms-strapi` | Strapi adapter implementation | npm |
| `@propeller/accelerator-nextjs` | Full Next.js app | git clone |
| `@propeller/accelerator-vue` | Full Vue app (coming) | git clone |

## How this section is organized

This section covers what is specific to the Storefront SDK. The pages follow a natural reading order:

1. **[Choosing Your Approach](/frontend/storefront-sdk/choosing-your-approach)** — three common partner architectures and a decision table to find the right fit
2. **[SDK Services](/frontend/storefront-sdk/sdk-services)** — Layer 1 deep dive: typed services, initialization and usage examples
3. **[UI Components](/frontend/storefront-sdk/ui-components)** — Layer 2 deep dive: component inventory, callbacks, stack-agnostic documentation
4. **[Accelerator](/frontend/storefront-sdk/accelerator)** — Layer 3 deep dive: state management, configuration and what works without a CMS
5. **[CMS Integration](/frontend/storefront-sdk/cms-integration)** — the adapter pattern, bridge blocks and dynamic block rendering
6. **[Routing](/frontend/storefront-sdk/routing)** — commerce routes, CMS routes and URL configuration
7. **[Customization](/frontend/storefront-sdk/customization)** — callbacks, pass-through properties and override patterns
8. **[B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities)** — portal modes, contact-company model and clusters

## How this relates to the domain guides

The domain guides teach you how to work with products, pricing, cart and checkout, accounts and orders using raw GraphQL queries. Those concepts apply whether you use the SDK or build from scratch with your own framework.

The SDK wraps many of those queries into typed services and pre-built components. When you use a [`ProductGrid`](/reference/storefront-sdk/product-display/product-grid) component, it runs the same product queries described in the domain guides. Understanding the underlying queries helps you customize components and debug issues.

## Component reference

<!-- TODO: Component reference docs will be fetched dynamically from the SDK repository. This section will link to them once the auto-sync pipeline is in place. -->

Individual component documentation (properties, callbacks, usage examples) will be available as part of the [UI Components](/frontend/storefront-sdk/ui-components) section. Each component has its own documentation file covering basic and extended usage, properties, methods and callbacks.

---

## Behavior and Display

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/behavior-and-display

# Behavior and display

The Behavior tab controls how users interact with your storefront: portal access, checkout options, catalog display, pricing, user accounts, analytics tracking and performance settings.

Go to **Propeller > Behavior** in your WordPress admin to access these settings.

## Basic configuration

| Setting | Description |
|---------|-------------|
| **Shop home country** | The home country of the webshop. Drives ICP settings, default tax zones and regional configurations. |

## Access and security

These settings control who can access the storefront and which security features are enabled.

| Setting | Description |
|---------|-------------|
| **Closed portal mode** | When enabled, anonymous users land on the login page. They cannot browse the catalog, see prices or access any storefront content until they log in. |
| **Semi-closed portal mode** | When enabled, anonymous users can browse the catalog but cannot see prices, stock levels or add products to the cart. They must log in to access pricing and ordering. |
| **Allow guest checkout** | When enabled, visitors can place orders without creating an account. |
| **Enable SSO** | Enables Single Sign-On authentication. Allows users to log in through an external identity provider instead of the plugin's built-in login. |
| **Enable reCAPTCHA** | Adds Google reCAPTCHA to forms (login, registration, contact) to prevent automated submissions. |
| **Enable Google Analytics 4 & Tag Manager** | Enables integration with Google Analytics 4 and Google Tag Manager for tracking storefront events (page views, add to cart, purchases). |
| **Enable cXML Punchout** | Enables cXML Punchout support for B2B procurement. Allows buyers to access the catalog from their procurement system, select products and send the cart back as a purchase order. |


Closed portal mode and semi-closed portal mode are mutually exclusive. Closed portal mode redirects anonymous users to the login page. Semi-closed portal mode lets anonymous users browse products but hides prices, stock levels and add-to-cart functionality until they log in.

If neither is enabled, the storefront operates as an open portal where anonymous visitors can browse, see prices and place orders.


## Checkout and cart

These settings control checkout behavior and which options are available during the order process.

| Setting | Description |
|---------|-------------|
| **On account payment types** | Comma-separated list of payment type identifiers for which third-party payment providers are skipped (for example `REKENING`). Orders placed with these payment types are invoiced to the customer's account rather than routed through a payment provider. |
| **Enable partial delivery** | Allows orders to be split into multiple shipments. When enabled, customers can choose to receive available items first and have the rest shipped later. |
| **Enable carrier selection** | Shows a carrier selection step during checkout. Customers can choose their preferred shipping carrier. |
| **Enable delivery date picker** | Shows a date picker during checkout so customers can select a preferred delivery date. |
| **Show action code field** | Displays a field during checkout where customers can enter an action code (discount code or promotion code). |
| **Show order type field** | Displays a field during checkout where customers can specify the order type. |

## Product catalog and display

Configure default sorting behavior and pagination for category, search and brand listing pages.

| Setting | Description |
|---------|-------------|
| **Default sort field** | The field used to sort product listings by default. Options include Modified, Name, Price and other product fields. |
| **Secondary sort field** | Tie-breaker sort applied to product listings, when multiple products have the same value for the default sort. For example, if the Default sort field is set to price, products with identical prices would appear in an unpredictable order. The Secondary sort field (e.g., name) ensures those tied products are then sorted alphabetically.|
| **Direction** | The default sort direction: ascending (Asc) or descending (Desc). |
| **Per page** | Number of products shown per page in the catalog listing. |
| **Auto-load product specifications** | When enabled, product specifications (attributes) are automatically loaded in the background on product detail pages. |
| **Enable stock validation** | When enabled, displays a warning popup when the ordered quantity exceeds available stock. |
| **Product page tab behavior** | Controls whether customers can toggle product detail pages to open in new tabs while browsing catalog pages. Options: **On** (PDP pages open in a new browser tab), **Off** (PDP pages open in the same tab) or **Hidden** (the toggle option is not shown to customers and remains off). |

## Pricing and tax

| Setting | Description |
|---------|-------------|
| **Include VAT by default** | When enabled, prices are displayed including VAT throughout the storefront and the VAT switcher defaults to VAT-inclusive. |

## User accounts

These settings control account registration and management features.

| Setting | Description |
|---------|-------------|
| **Automatic login after registration** | When enabled, new users are automatically logged in after completing registration instead of being redirected to the login page. |
| **Allow address management** | When enabled, users can add new addresses and edit existing ones in their account. |
| **Allow account management** | Enables customers with the authorization manager role to create and delete accounts for their company. |

## Display options

These settings define which attributes are used to personalize content and enhance tracking. Each field accepts a comma-separated list of Propeller attribute names.

| Setting | Description |
|---------|-------------|
| **User tracking attributes** | The attribute used to personalize content and track behavior for individual users. |
| **Company tracking attributes** | Attributes used to personalize content for company accounts (comma-separated). |
| **Product tracking attributes** | Attributes used to display additional product information and enhance tracking (for example `PROPELLER_CATEGORIE,PROPELLER_TYPE`). |
| **Category tracking attributes** | Attributes used to display additional category information and enhance tracking. |

## Performance and technical

These settings affect how the plugin handles sessions, assets and URLs.

| Setting | Description |
|---------|-------------|
| **Enable WordPress sessions** | Integrates and synchronizes Propeller sessions with WordPress sessions. |
| **Assets enqueuing type** | Controls how the plugin loads its CSS and JavaScript files. **Standard** loads assets only where needed (use plugins like Autoptimize for optimization). **Global/Minified** combines and minifies all assets but loads them globally, which may impact performance. |
| **Enable lazy loading for images** | Lazy loads images from the API on category, brand, search and product detail pages to improve performance. |
| **Use session language for attributes** | When enabled, attributes are fetched only in the currently selected language instead of retrieving all available language versions. |
| **Include ID in product/category URLs** | Appends the object ID to product and category URLs for improved tracking and consistency. |

## Next steps

- [Translations and valuesets](/frontend/wordpress-plugin/translations-and-valuesets) — manage UI labels and value lists

---

## General Settings

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/general-settings

# General settings

The General tab is the first stop after installing the plugin. It connects WordPress to your Propeller environment and configures which data the storefront loads.

Go to **Propeller > General** in your WordPress admin to access these settings.

## API connection

These fields connect the plugin to Propeller's GraphQL API.

### API URL

The GraphQL endpoint URL (for example `https://api.helice.cloud/v2/graphql`). Only change this if you use a different or staging environment.

### API key

The API key used for general storefront operations: browsing the catalog, loading product data, fetching categories and handling authentication. The plugin sends this key with every standard GraphQL request.

### Orders API key

A separate API key with permissions specifically for order management operations. The plugin uses this key for order-related mutations such as placing orders and managing cart state.

The two keys follow the principle of least privilege. The standard API key has the minimum permissions needed for catalog browsing and general frontend operations. The orders key adds the specific permissions required for order processing. This separation limits the impact if a key is compromised.

Some features require additional API key permissions beyond the defaults. For example, authorization requests and letting contacts add other contacts to their company require specific permissions on the API key. If a feature is not working, check that your API keys have the necessary permissions in the Propeller Backoffice.

See [Environments and access](/getting-started/platform-architecture/environments-and-access) for how to get your credentials.

## Environment settings

These fields tell the plugin which data to load from Propeller.

### Anonymous user ID

The user ID used for anonymous (not logged in) visitors. Propeller requires a user context for pricing and availability lookups. The anonymous user ID determines which price list and product visibility rules apply to visitors who have not logged in.

### Catalog root ID

The root category ID for the product tree. The plugin starts browsing from this category and shows all its descendants. Use this to scope the catalog to a specific part of your category tree. For example, if your Propeller environment has categories for multiple brands, set the root to the brand category this site should show.

### Channel ID

The channel this WordPress site represents. A channel in Propeller is a specific frontend or sales experience, such as a webshop, a B2B dealer portal or a mobile ordering app. Each channel belongs to one tenant, and a tenant can have multiple channels.

Channels handle presentation-specific configuration: SEO settings, templates, catalog structure, languages and anonymous user behavior. The underlying commercial data (products, pricing, customers, orders) is shared at the tenant level, while each channel maintains its own customer experience.

For example, a single tenant could power three channels: a public webshop, a dealer portal and a mobile ordering app. All three share the same product catalog and pricing rules, but each channel presents a tailored experience to its audience.

Set the Channel ID to the channel this WordPress site should use.

### Default currency

The currency code used for displaying prices (for example `EUR`, `USD`, `GBP`).

## Email settings

### CC Email

An email address that receives a copy of emails sent by the plugin (price request, return request emails). Use this to keep an internal team informed of storefront activity.

### BCC Email

An email address that receives a blind copy of price request and return request emails. The recipient is not visible to the customer. Use this for logging or compliance purposes.

## Next steps

- [Pages and shortcodes](/frontend/wordpress-plugin/pages-and-shortcodes) — configure page slugs and shortcodes
- [Behavior and display](/frontend/wordpress-plugin/behavior-and-display) — toggle features and display options

---

## Multi-site Setup

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/multi-site-setup

# Multi-site setup

The Propeller WordPress Plugin supports WordPress Multisite. This page explains how to install, activate and configure the plugin across a network of WordPress sites.

## Network-level installation

In a Multisite network, install the plugin at the network level:

1. Go to **Network Admin > Plugins**
2. Upload and install the Propeller plugin
3. Choose whether to **Network Activate** (activates for all sites) or leave it for per-site activation

### Network Activate vs per-site activation

- **Network Activate** — The plugin is active on every site in the network. Each site still needs its own configuration (API key, Channel ID, etc.) but the plugin code is loaded everywhere.
- **Per-site activation** — Only sites where an admin explicitly activates the plugin will load it. Use this when only some sites in the network need commerce functionality.

## Per-site configuration

Even when the plugin is installed at the network level, each site has its own configuration. Go to **Propeller > General** on each individual site to set:

- API key and Orders API key
- Channel ID
- Catalog root ID
- Anonymous user ID

See [Install and Configure](/getting-started/wordpress-plugin/install-and-configure) for setup steps and [General settings](/frontend/wordpress-plugin/general-settings) for field descriptions.

This means each site in the network can connect to a different Propeller channel, show a different catalog and serve different audiences.

## Common multi-site scenarios

### One catalog, multiple languages

All sites share the same Propeller environment and catalog root. Each site serves a different language. Products, categories and prices come from the same source but are displayed in the site's language.

Configuration:
- Same API keys on all sites
- Same Channel ID on all sites
- Same Catalog root ID on all sites
- Set the website language on each site via **WordPress Settings > General > Site Language**. When you change the site language, product and catalog data is also fetched in that language from Propeller
- For sites that support multiple languages, use TranslatePress (see [Translations and valuesets](/frontend/wordpress-plugin/translations-and-valuesets))

### Separate catalogs per site

Each site shows a different subset of products. This is useful when you run multiple brands or business units from a single WordPress Multisite network. Each site uses a different Catalog root ID to show a different branch of the category tree in Propeller.

Configuration:
- Different Catalog root IDs per site (each site starts from a different branch of the category tree)
- Same or different Channel IDs depending on your setup (different channels can also provide different anonymous user pricing)
- Same or different API keys depending on your Propeller setup
- Language and currency configured per site

### Shared network, selective commerce

Only some sites in the network need commerce functionality. The rest are regular WordPress sites (blogs, marketing pages, documentation).

Configuration:
- Install the plugin at network level but do **not** Network Activate
- Activate the plugin only on sites that need commerce
- Non-commerce sites are unaffected by the plugin

## Considerations

- **Performance** — Each site makes its own GraphQL API calls. A network with many active sites generates more API traffic. Consider Propeller's rate limits and caching when planning a large network.
- **Caching** — Only cache pages for anonymous (non-logged-in) visitors. Do not cache content for logged-in users because B2B storefronts show customer-specific catalogs, pricing and order data that varies per user.
- **Updates** — Updating the plugin at the network level updates it for all sites. Test updates on a staging environment before applying to production.

## Next steps

- [Understanding the plugin](/frontend/wordpress-plugin/understanding-the-plugin) — how the plugin architecture works

---

## Pages and Shortcodes

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/pages-and-shortcodes

# Pages and shortcodes

The Pages tab controls which WordPress pages the plugin uses for commerce functionality. Pages are powered by shortcodes that render commerce features. Some pages use a single shortcode, others combine multiple shortcodes.

Go to **Propeller > Pages** in your WordPress admin to access these settings.

## Page types

When you activate the plugin it creates a set of WordPress pages automatically. Each page has a type that determines its role in the storefront. The default configuration is ready to use. You can change page settings, reassign shortcodes or adjust URL slugs if needed through the Pages tab.

The available page types are:

### Catalog and product pages

- Category page
- Product page
- Cluster page
- Search page
- Brand page
- Machines page

### Cart and checkout pages

- Shopping cart page
- Checkout page
- Checkout summary page
- Checkout thank you page

### Payment pages

These pages are used by the payment provider plugins ([MultiSafepay](https://github.com/propeller-commerce/wordpress-multisafepay-v2), [Mollie](https://github.com/propeller-commerce/wordpress-mollie-v2)) to handle payment flow callbacks.

- Payment check page
- Thank you page
- Payment failed page
- Payment being processed page
- Payment cancelled page
- Expired payment request page

### Account pages

- My account page
- My account mobile page
- Account details page
- Addresses page
- Favorites page
- Quick order page


### Order and quote pages

- Orders page
- Order details page
- Orderlist page
- Quotations page
- Quotation details page
- Invoices page
- Price request page

### Purchase authorization pages

- Purchase authorizations page
- Purchase authorization requests page
- Purchase authorization thank you page
- Authorization confirmed page

### Authentication pages

- Login page
- Register page
- Forgot password page
- Reset password page
- SSO Login page

### Other pages

- Terms & Conditions page

## Page configuration

Each page in the Pages tab has the following configuration fields:

| Field | Description |
|-------|-------------|
| **Page name** | The WordPress page title. |
| **Type** | The page type from the dropdown. Determines the page's role in the storefront. |
| **Shortcode** | The shortcode assigned to render commerce content on this page. |
| **Slug** | The URL path for this page (for example `products` makes the page available at `yoursite.com/products/`). |
| **Apply Read/Write rules** | When enabled, applies Propeller's read/write permission rules to this page. |
| **Is My account page** | Marks this page as the main account dashboard. |
| **Child of My Account** | Nests this page under the account section in navigation. |

## Shortcodes

Pages use shortcodes to render commerce content. The relationship is not always 1:1. Some pages combine multiple shortcodes. For example, the account dashboard can include `account-recent-orders`, `account-recent-favorites`, `account-recent-invoices` and `purchase-authorizations-short-list`, each showing a specific subset of data.

The plugin provides shortcodes for all commerce features. You can use these shortcodes on any WordPress page, not just the predefined ones. This lets you combine Propeller commerce content with regular WordPress content on the same page.

### Navigation and layout

| Shortcode | Description |
|-----------|-------------|
| `menu` | Main navigation menu |
| `mini-account` | Compact account widget (header login/account link) |
| `account-menu` | Account section navigation menu |
| `favorites-menu` | Favorites icon/link for the header |
| `price-toggle` | VAT inclusive/exclusive price switcher |

### Catalog and products

| Shortcode | Description |
|-----------|-------------|
| `product-listing` | Product listing with filtering and sorting |
| `product-details` | Single product page |
| `cluster-details` | Cluster (product group with variants) page |
| `product-slider` | Product carousel/slider |
| `search` | Search results page |
| `brand-listing` | Brand overview page |
| `brand-listing-content` | Brand page with product listing |
| `machines` | Machine park overview |

### Cart and checkout

| Shortcode | Description |
|-----------|-------------|
| `shopping-cart` | Full shopping cart page |
| `mini-shopping-cart` | Compact cart widget (header cart icon with count) |
| `mini-checkout-cart` | Compact cart summary during checkout |
| `checkout` | Checkout page |
| `checkout-summary` | Order summary before placing the order |
| `checkout-thank-you` | Order confirmation page |
| `quick-add-to-basket` | Quick order form (add by SKU/quantity) |

### Payment status

| Shortcode | Description |
|-----------|-------------|
| `payment-failed` | Payment failed status page |
| `payment-processed` | Payment being processed status page |
| `payment-cancelled` | Payment cancelled status page |
| `payment-expired` | Expired payment request page |
| `authorization-confirmed` | Payment authorization confirmed page |

### Account

| Shortcode | Description |
|-----------|-------------|
| `account-page` | Account dashboard |
| `account-details` | Account details with dashboard |
| `account-details-section` | Account details section (partial) |
| `account-details-no-dashboard` | Account details without dashboard |
| `account-company-name` | Company name display |
| `account-recent-orders` | Recent orders widget |
| `account-recent-quotations` | Recent quotations widget |
| `account-mobile` | Mobile account page |
| `account-addresses` | Address book |
| `contact-companies` | Company contacts overview |


### Orders, quotes and invoices

| Shortcode | Description |
|-----------|-------------|
| `account-orders` | Order history |
| `account-order-details` | Single order detail page |
| `account-quotations` | Quotation history |
| `account-invoices` | Invoice history |
| `account-recent-invoices` | Recent invoice history |

### Favorites

| Shortcode | Description |
|-----------|-------------|
| `account-favorites` | Favorites lists overview |
| `account-recent-favorites` | Recently modified favorites lists |


### Authentication

| Shortcode | Description |
|-----------|-------------|
| `login-page` | Login form with guest checkout option (continue to order as a guest) |
| `login-form` | Standalone login form without guest checkout option |
| `forgot-password-form` | Forgot password form |
| `reset-password-form` | Reset password form |
| `registration-form` | Registration form |
| `sso-sign-in` | Single Sign-On login |

### Other

| Shortcode | Description |
|-----------|-------------|
| `price-request` | Price request form |
| `purchase-authorizations` | Purchase authorization overview |
| `purchase-authorization-requests` | Purchase authorization requests |
| `purchase-authorization-thank-you` | Purchase authorization confirmation |
| `purchase-authorizations-short-list` | Recent purchase authorization requests |

## Template customization

Each shortcode maps to a PHP template file in `/plugins/propeller-ecommerce-v2/public/templates/`. For example, the `product-details` shortcode renders through `propeller-product-details.php`. Templates reference partial templates in `/plugins/propeller-ecommerce-v2/public/partials/` using PHP require statements via `BaseController::load_template()`.

The plugin resolves templates in this priority order:

1. **Theme override** — Place files in your active theme under `propeller/templates/`, `propeller/partials/`, etc. These take highest priority.

2. **Extend plugin override** — Define `PROPELLER_PLUGIN_EXTEND_DIR` in `wp-config.php` pointing to a custom plugin directory (typically in `/mu-plugins/`). Place files under `public/templates/`, `public/partials/`, etc. within that directory.

3. **Default plugin templates** — The built-in templates in `/plugins/propeller-ecommerce-v2/public/` are used as fallback.

Additionally, you can use filter hooks in `custom-filters.php` (placed in the extend directory) to swap partial template paths. For example, `apply_filters('propel_product_gallery', ...)` lets you replace the product gallery partial with your own template file.

## Next steps

- [Behavior and display](/frontend/wordpress-plugin/behavior-and-display) — configure feature toggles and display options

---

## Sitemaps

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/sitemaps

# Sitemaps

The Sitemap tab lets you generate and manage XML sitemaps from your Propeller product, category and brand data. Sitemaps help search engines discover and index your commerce pages.

Go to **Propeller > Sitemap** in your WordPress admin to access these settings.

## Generated sitemaps

The plugin generates three types of sitemaps, each created per language configured on your site:

| Sitemap type | Contents |
|-------------|----------|
| **Brands** | URLs for all brand pages |
| **Catalog** | URLs for category pages |
| **Products** | URLs for product detail pages |

Files follow the naming convention `propel-sitemap-{type}-{language}-{page}.xml`. For example, a site with English and Dutch generates:

- `propel-sitemap-brands-en-1.xml`
- `propel-sitemap-brands-nl-1.xml`
- `propel-sitemap-catalog-en-1.xml`
- `propel-sitemap-catalog-nl-1.xml`
- `propel-sitemap-products-en-1.xml`
- `propel-sitemap-products-nl-1.xml`

The number suffix (`-1`, `-2`, etc.) handles pagination for large catalogs that exceed the maximum URLs per file.

Each sitemap contains standard `<url><loc>` entries with the full URL for each page.

## Generating sitemaps

Sitemaps can be generated in two ways:

**Automatic generation** — The plugin runs a scheduled task daily after midnight when the webshop is not under heavy usage. Generation may take a while depending on the size of your catalog.

**Manual generation** — Click the **Generate sitemap** button to regenerate immediately. This is useful after making changes to your content or products.

The admin shows a warning when your sitemaps were generated more than 24 hours ago, prompting you to regenerate if you have made recent changes.

## Yoast SEO integration

The Sitemap tab shows the status of the Yoast SEO plugin integration.

**When Yoast SEO is active**, Propeller's `sitemap.xml` file is not used. Yoast manages the sitemap index instead. The admin links to Yoast's `sitemap_index.xml` so you can verify the combined sitemap.

**When Yoast SEO is not active**, Propeller's own sitemap files are served directly.

## Next steps

- [Multi-site setup](/frontend/wordpress-plugin/multi-site-setup) — run the plugin across a WordPress Multisite network

---

## Translations and Valuesets

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/translations-and-valuesets

# Translations and valuesets

The Translations and Valuesets tabs manage the text content and predefined value lists used throughout the storefront. Use these settings to localize the UI and configure the options that appear in dropdowns and filters.

## Translations

Go to **Propeller > Translations** in your WordPress admin.

The plugin ships with default UI labels in English (and other supported languages). The Translations tab lets you override any label for any language.

### What can be translated

Translations cover all user-facing text rendered by the plugin:

- Button labels (add to cart, proceed to checkout, place order)
- Form labels and placeholders (name, address, email)
- Navigation items (catalog, account, cart)
- Status messages (order placed, quote submitted, item added)
- Error messages (out of stock, invalid quantity, login required)
- Section headings and descriptions

These are **plugin UI labels**, not product content. Product names, descriptions and attribute values come from Propeller and are managed through the API or Backoffice. For translating product data and other content on the page, use TranslatePress or the WordPress site language setting.

### Managing translations

Each translation has a key and a value per language. The Translations tab shows a list of all available keys with their current values. To change a label:

1. Find the key in the list (use the search field to filter)
2. Edit the value for the language you want to change
3. Save the changes

Your overrides take effect immediately on the storefront.

### Changing the site language

To set the website language, go to **WordPress Settings > General > Site Language**. When you change the site language, the plugin fetches product and catalog data in that language from Propeller. You can override any plugin UI label for that language through the Translations tab.

### Multi-language setups

For sites that support multiple languages, use TranslatePress. TranslatePress is the recommended translation plugin. The free version supports up to two languages. Propeller has not tested with other translation plugins.

The Propeller plugin provides a language switcher shortcode that works with TranslatePress. Plugin UI label translations are managed through the Translations tab. TranslatePress handles the rest of the page content.

## Valuesets

Go to **Propeller > Valuesets** in your WordPress admin.

Valuesets in Propeller are predefined lists of allowed values used for product attributes, filters and dropdowns. For example, a "Color" attribute might use a valueset containing "Red", "Blue" and "Green". These values appear in product specifications and catalog filters.

### How valueset localization works

Valuesets in Propeller are localized, meaning each value can have translations for every language configured in your environment. When the plugin fetches product data through the GraphQL API, valueset values are returned in the requested language automatically.

### What the Valuesets tab does

The Valuesets tab fetches all valuesets from the Propeller API and adds them as translation entries in the plugin. This was originally built to work around a limitation in an earlier version of the API where localized valueset values were not reliably returned. The plugin would fetch the valueset values and store them locally as translations, ensuring they displayed correctly in the storefront regardless of API behavior.

### Do you need this?

This feature is under review and may be removed in a future version of the plugin. The v2 GraphQL API returns localized valueset values directly, which makes the local copy in the plugin unnecessary. The current recommendation is to leave the Valuesets tab as is.

## Next steps

- [Sitemaps](/frontend/wordpress-plugin/sitemaps) — configure XML sitemap generation
- [Multi-site setup](/frontend/wordpress-plugin/multi-site-setup) — run multiple storefronts from one WordPress installation

---

## Understanding the Plugin

URL: https://docs.propeller-commerce.com/frontend/wordpress-plugin/understanding-the-plugin

# Understanding the plugin

How the Propeller WordPress Plugin works under the hood and what it provides. This page gives you the mental model before you start configuring. The plugin source code is available on [GitHub](https://github.com/propeller-commerce/wordpress-v2).

## The plugin is a frontend layer

The WordPress Plugin is not a standalone commerce engine. It does not store products, prices or orders in the WordPress database. Instead it calls Propeller's GraphQL API on every page load and renders the response using PHP templates.

The data flow looks like this:

1. A visitor opens a page on your WordPress site
2. The plugin's shortcode on that page triggers one or more GraphQL queries to the Propeller API
3. The API returns product data, pricing, stock levels or account information
4. The plugin renders the response through a PHP template and outputs HTML

This means your product catalog, pricing rules, order processing and account management all live in Propeller. WordPress handles the CMS layer (pages, menus, blog posts) while the plugin handles the commerce layer.

## One package, everything included

The plugin ships as a single package with all features included. There are no paid add-ons, premium tiers or feature unlocks. When you install the plugin you get the full set of B2B capabilities: catalog browsing, customer-specific pricing, ordering, quoting, favorites, budget management and account features.

This is different from ecosystems like WooCommerce where functionality is split across dozens of separate plugins. With the Propeller plugin everything works together out of the box.

## Portal access modes

The plugin supports three access modes that control what anonymous visitors can see and do:

- **Open portal** — Anonymous visitors can browse the catalog, see prices and place orders. This is the default.
- **Semi-closed portal** — Anonymous visitors can browse the catalog but cannot see prices, stock levels or add products to the cart. They must log in to access pricing and ordering.
- **Closed portal** — Anonymous visitors land on the login page and cannot access any storefront content until they log in.

These modes are configured in the [Behavior tab](/frontend/wordpress-plugin/behavior-and-display#access-and-security).

## Predefined pages and shortcodes

The plugin creates a set of predefined WordPress pages during activation. Each page contains a shortcode that renders a specific part of the commerce experience:

| Page | Purpose |
|------|---------|
| Catalog | Product listing with filtering and sorting |
| Product detail | Single product or cluster page |
| Shopping cart | Cart contents and order summary |
| Checkout | Address, payment and order placement |
| Account / Dashboard | Customer portal with orders, quotes and settings |
| Login / Register | Authentication pages |

You can also use shortcodes on custom WordPress pages to embed Propeller commerce content alongside regular CMS content. See [Pages and shortcodes](/frontend/wordpress-plugin/pages-and-shortcodes) for the full list.

## Admin configuration tabs

The plugin settings are organized into six tabs in the WordPress admin under the Propeller menu:

| Tab | What it controls |
|-----|-----------------|
| **General** | API connection (two API keys), channel and currency |
| **Pages** | Page slugs, shortcode assignments and language-specific URL overrides |
| **Behavior** | Feature toggles and display options |
| **Translations** | UI labels and their translations per language |
| **Valuesets** | Predefined value lists for dropdowns and filters |
| **Sitemap** | XML sitemap generation from Propeller data |

Each tab has a dedicated guide page in this section.

## Payment provider plugins

To process online payments you need a separate WordPress plugin for your payment service provider. Propeller provides two open source payment plugins:

- [MultiSafepay](https://github.com/propeller-commerce/wordpress-multisafepay-v2) for MultiSafepay payment processing
- [Mollie](https://github.com/propeller-commerce/wordpress-mollie-v2) for Mollie payment processing

Install the payment plugin alongside the main Propeller plugin and configure it with your PSP credentials. Orders placed with on-account payment types (configured in [Behavior and display](/frontend/wordpress-plugin/behavior-and-display)) skip the payment provider entirely.

## How it relates to other frontend options

The plugin uses the same GraphQL API that the Storefront SDK and custom frontends use. The difference is in who controls the rendering:

- **WordPress Plugin** — Propeller controls the templates. You configure through admin settings and can override templates in your theme.
- **Storefront SDK** — You build the frontend in Next.js using Propeller's React components and hooks.
- **Custom frontend** — You build everything from scratch using the GraphQL API directly.

The plugin is the fastest way to get a working B2B portal. For full control over the user experience, partners typically move to the Storefront SDK or a custom frontend.

## Next steps

- [General settings](/frontend/wordpress-plugin/general-settings) — configure the API connection and environment
- [Pages and shortcodes](/frontend/wordpress-plugin/pages-and-shortcodes) — manage pages, slugs and shortcodes
- [Behavior and display](/frontend/wordpress-plugin/behavior-and-display) — toggle features and display options
- [Translations and valuesets](/frontend/wordpress-plugin/translations-and-valuesets) — manage UI labels and value lists
- [Sitemaps](/frontend/wordpress-plugin/sitemaps) — configure XML sitemap generation
- [Multi-site setup](/frontend/wordpress-plugin/multi-site-setup) — run the plugin across a WordPress Multisite network

---

## Build a Frontend

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend

# Build a Frontend

Build a customer-facing B2B frontend on Propeller; a webshop, customer portal or dealer portal. Choose the approach that fits your team and project.

## Using the Storefront SDK

The fastest path, if not making use of the WordPress Plugin. The Storefront SDK provides typed SDK services, pre-built UI components and an optional Accelerator app with routing, CMS integration and B2B features like customer-specific pricing, company accounts and quote flows. Use just the services in any JavaScript project, add the pre-built components to a React or Vue project, use the stack-agnostic component documentation to build in any other framework, or clone the full Accelerator to get a working storefront out of the box.

**Best for:** teams who want pre-built commerce functionality, whether as a complete app or as individual packages in an existing project.

[Get started with the Storefront SDK &rarr;](/getting-started/build-a-frontend/using-the-storefront-sdk)

## Using your own Framework

Full control. Connect directly to Propeller's GraphQL API from Vue, Angular, Svelte, Nuxt or any other frontend technology. Write your own queries, build your own components and own the entire architecture.

**Best for:** teams with an existing frontend stack or specific architectural requirements.

[Get started with your own framework &rarr;](/getting-started/build-a-frontend/using-your-own-framework)

---

## Clone and Run

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-the-storefront-sdk/clone-and-run

# Clone and Run


The Storefront SDK is in beta. Content in this section may be updated as the SDK evolves.


Get the [Accelerator](/frontend/storefront-sdk/accelerator) running locally with your Propeller environment. The Accelerator is a complete working storefront app that uses [SDK Services](/frontend/storefront-sdk/sdk-services) and [UI Components](/frontend/storefront-sdk/ui-components) internally.

## Prerequisites

- Node.js 20 or higher
- A Propeller environment with a GraphQL API endpoint and key ([how to get credentials](/getting-started/platform-architecture/environments-and-access))

## Step 1: Clone the repository

Contact Propeller to get access to the Accelerator repository. Once you have access:

```bash
git clone <repository-url-provided-by-propeller>
cd <repository-name>
```

## Step 2: Install and configure

```bash
npm install
```

<!-- TODO: Confirm env var names, file name (.env.local?) and add example values -->

Copy the example environment file and fill in your Propeller credentials. You need your GraphQL endpoint URL and API key.

```bash
cp .env.example .env.local
```

Open `.env.local` and set the values for your environment.

## Step 3: Start the development server

<!-- TODO: Confirm the dev command (npm run dev? npm start?) and the port -->

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser. You should see a working frontend with your product catalog.

<!-- TODO: Describe what the partner actually sees — catalog page with products, navigation categories, search bar? Add a screenshot if possible -->

## Next steps

Continue to [What's Next](/getting-started/build-a-frontend/using-the-storefront-sdk/whats-next) for links to guides on the SDK layers, customization and commerce domains.

---

## Using the Storefront SDK

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-the-storefront-sdk

# Using the Storefront SDK

The Storefront SDK provides three layers for building customer-facing experiences on Propeller. Each layer builds on the previous one:

- **[SDK Services](/frontend/storefront-sdk/sdk-services)** — typed TypeScript services that wrap Propeller's GraphQL API. Works in any JavaScript or TypeScript project.
- **[UI Components](/frontend/storefront-sdk/ui-components)** — pre-built e-commerce components (product grids, cart, checkout, account pages and more). Available for React and Vue via npm. Stack-agnostic component documentation available for building in any framework.
- **[Accelerator](/frontend/storefront-sdk/accelerator)** — a complete working storefront app. Clone it, configure it, customize it. Available as a Next.js app (`@propeller/accelerator-nextjs`), with a Vue version coming.

Each layer is independently usable. You do not need the Accelerator to use UI Components. You do not need UI Components to use SDK Services.

## Three common approaches

Partners typically use one of three approaches:

| Approach | What you use | Best for |
|---|---|---|
| **Commerce-led** | Accelerator (all three layers) | Greenfield projects where speed to market is the priority |
| **CMS-led** | SDK Services + UI Components | Multi-brand or multi-site environments where the CMS owns all routing |
| **SDK-only** | SDK Services only | Partners with strict architectural requirements or unsupported frameworks |

See [Choosing Your Approach](/frontend/storefront-sdk/choosing-your-approach) for a full decision table.

## This track: getting started with the Accelerator

This getting-started track walks you through **cloning and running the Accelerator** (the commerce-led approach). This is the fastest path to a working frontend.

1. [Clone and Run](/getting-started/build-a-frontend/using-the-storefront-sdk/clone-and-run) — get the Accelerator running locally with your Propeller environment
2. [What's Next](/getting-started/build-a-frontend/using-the-storefront-sdk/whats-next) — where to go from here

If your project uses a CMS-led or SDK-only approach, skip this track and go directly to the [Storefront SDK guides](/frontend/storefront-sdk/understanding-the-storefront-sdk).

If you prefer to use your own framework without the SDK, see [Using your own Framework](/getting-started/build-a-frontend/using-your-own-framework).

---

## What's Next

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-the-storefront-sdk/whats-next

# What's Next

You have a running Accelerator connected to your Propeller environment. Here is where to go from here.

## Understand the SDK layers

Learn how the three layers of the Storefront SDK work and how to use each one:

- [Understanding the Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk) — the three-layer architecture and how the pieces fit together
- [Choosing Your Approach](/frontend/storefront-sdk/choosing-your-approach) — common partner architectures and a decision table
- [SDK Services](/frontend/storefront-sdk/sdk-services) — the typed TypeScript services that power everything
- [UI Components](/frontend/storefront-sdk/ui-components) — pre-built components, callbacks and the stack-agnostic documentation
- [Accelerator](/frontend/storefront-sdk/accelerator) — state management, configuration and what works without a CMS

## Customize the Accelerator

- [CMS Integration](/frontend/storefront-sdk/cms-integration) — connect Strapi or another headless CMS using the adapter pattern
- [Routing](/frontend/storefront-sdk/routing) — customize URL patterns and configure CMS routes
- [Customization](/frontend/storefront-sdk/customization) — callbacks, pass-through properties and override patterns
- [B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities) — portal modes, contact-company model and clusters

## Learn the commerce domains

The frontend domain guides explain how each commerce domain works in Propeller and how to build with it:

- [Products and catalog](/frontend/domain-guides/products-and-catalog/querying-products) — product queries, search and filtering
- [Pricing and discounts](/frontend/domain-guides/pricing-and-discounts/understanding-pricing-layers) — pricing layers, price sheets and discount resolution
- [Cart and checkout](/frontend/domain-guides/cart-and-checkout/cart-management) — cart mutations, checkout flow and order creation
- [Authentication](/frontend/domain-guides/accounts-and-authentication/authentication-and-authorization) — login, registration and session management

## Connect business systems

If you also need to sync products, pricing, orders or customers from an ERP, PIM or CRM, see [Build an Integration](/getting-started/build-an-integration).

## Use a different framework

If you decide to build without the SDK, the [Using your own Framework](/getting-started/build-a-frontend/using-your-own-framework) track walks you through connecting to the GraphQL API from Vue, Angular, Svelte or any other stack.

---

## Authenticate

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-your-own-framework/authenticate

# Authenticate

Connect to Propeller's GraphQL API and verify your credentials work.

## Prerequisites

- A Propeller GraphQL API key, created in the Backoffice under **Admin > API Key Management** (see [Environments and Access](/getting-started/platform-architecture/environments-and-access))

## API connection details

All requests go to a single endpoint using the `apiKey` header for authentication.

| Setting | Value |
|---|---|
| Endpoint | `https://api.helice.cloud/v2/graphql` |
| Method | `POST` |
| Header | `apiKey: YOUR_API_KEY` |

## Verify your API key

Send a simple query to confirm the connection works. Replace `YOUR_API_KEY` with your actual key.

```bash
curl -X POST https://api.helice.cloud/v2/graphql \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_API_KEY" \
  -d '{"query": "{ channels { id name } }"}'
```

**Expected result:**

```json
{
  "data": {
    "channels": [
      {
        "id": 1,
        "name": "B2B Portal"
      }
    ]
  }
}
```

If you see channel data, your API key is working.

## Set up a GraphQL client

Curl works for a quick credential check, but for exploring the API you want a GraphQL client. A client gives you autocomplete on fields, inline schema documentation and formatted responses.

Options:

- [GraphQL Explorer](/reference/graphql/explorer) built into these docs (no setup required)
- [Altair](https://altairgraphql.dev) (lightweight, available as browser extension or desktop app)
- [Postman](https://www.postman.com) (if you already use it for REST, it supports GraphQL too)

Configure your client with the endpoint and header from the table above, then run the same channels query:

```graphql
query GetChannels {
  channels {
    id
    name
  }
}
```

You should see the same channel data as the curl response.

## Next steps

Your credentials work and you have a GraphQL client ready. Continue to the next page to start building a catalog.

- [Build a Catalog Page](/getting-started/build-a-frontend/using-your-own-framework/build-a-catalog-page) covers fetching products, search and product detail queries
- [GraphQL Reference](/reference/graphql) has the full schema documentation

---

## Build a Catalog Page

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-your-own-framework/build-a-catalog-page

# Build a Catalog Page

Query the product catalog from Propeller and fetch the data you need for a catalog page on your frontend. Run these queries in the GraphQL client you set up on the previous page.

## Fetch the catalog

Use the `products` query to fetch a paginated catalog. The catalog can contain both clusters (products with variants) and standalone products, so the query uses inline fragments for both types.

This query fetches everything you need for a catalog page: product name, SKU, price, stock, slug (for URLs) and a thumbnail image.

```graphql
query GetCatalog($input: ProductSearchInput) {
  products(input: $input) {
    page
    itemsFound
    pages
    items {
      ... on Cluster {
        clusterId
        names {
          value
        }
        class
        slugs {
          value
        }
        defaultProduct {
          productId
          sku
          names(language: "NL") {
            value
          }
          inventory {
            totalQuantity
          }
          price(input: { taxZone: "NL" }) {
            gross
            net
          }
          media {
            images(search: { sort: ASC, offset: 1 }) {
              items {
                alt(language: "NL") {
                  value
                }
                imageVariants(
                  input: {
                    transformations: {
                      name: "thumb"
                      transformation: {
                        width: 240
                        height: 240
                        fit: BOUNDS
                        bgColor: "transparent"
                        canvas: { width: 240, height: 240 }
                      }
                    }
                  }
                ) {
                  url
                }
              }
            }
          }
        }
      }
      ... on Product {
        class
        productId
        sku
        slugs {
          value
        }
        names(language: "NL") {
          value
        }
        inventory {
          totalQuantity
        }
        price(input: { taxZone: "NL" }) {
          gross
          net
        }
        media {
          images(search: { sort: ASC, offset: 1 }) {
            items {
              alt(language: "NL") {
                value
              }
              imageVariants(
                input: {
                  transformations: {
                    name: "thumb"
                    transformation: {
                      width: 240
                      height: 240
                      fit: BOUNDS
                      bgColor: "transparent"
                      canvas: { width: 240, height: 240 }
                    }
                  }
                }
              ) {
                url
              }
            }
          }
        }
      }
    }
  }
}
```

**Variables:**

```json
{
  "input": {
    "language": "NL",
    "sortInputs": [
      {
        "field": "LAST_MODIFIED_AT",
        "order": "DESC"
      }
    ],
    "page": 1,
    "offset": 24
  }
}
```

**Expected result:**

```json
{
  "data": {
    "products": {
      "page": 1,
      "itemsFound": 36,
      "pages": 2,
      "items": [
        {
          "clusterId": 6,
          "names": [{ "value": "Smooth Cylinder Pendant Spotlight" }],
          "class": "CLUSTER",
          "slugs": [{ "value": "smooth-cylinder-pendant-spotlight" }],
          "defaultProduct": {
            "productId": 75,
            "sku": "SM-CYL-3K80-PSU",
            "names": [{ "value": "Smooth Cylinder 3000K CRI80+ PSU" }],
            "inventory": { "totalQuantity": 150 },
            "price": { "gross": 189.0, "net": 228.69 },
            "media": {
              "images": {
                "items": [
                  {
                    "alt": [{ "value": "Product image of Smooth Cylinder Pendant Spotlight" }],
                    "imageVariants": [{ "url": "https://media.helice.cloud/..." }]
                  }
                ]
              }
            }
          }
        },
        {
          "class": "PRODUCT",
          "productId": 45,
          "sku": "GT-HGW1",
          "slugs": [{ "value": "hidden-glow-wall-washer" }],
          "names": [{ "value": "Hidden Glow Wall Washer" }],
          "inventory": { "totalQuantity": 278 },
          "price": { "gross": 342.54, "net": 414.47 },
          "media": {
            "images": {
              "items": [
                {
                  "alt": [],
                  "imageVariants": [{ "url": "https://media.helice.cloud/..." }]
                }
              ]
            }
          }
        }
      ]
    }
  }
}
```

The `offset` field controls how many items per page. The `page` field controls which page to fetch. Use `slugs` for building product URLs in your frontend. See [Core Concepts](/getting-started/platform-architecture/core-concepts) for more on how clusters and standalone products relate to each other.

## Fetch a single product

When a user clicks a product in the catalog, fetch the full detail. Use the `product` query to look up a product by `productId`, `sku` or `slug`.

```graphql
query GetProduct($productId: Int, $language: String) {
  product(productId: $productId, language: $language) {
    productId
    sku
    class
    categoryId
    names {
      language
      value
    }
    descriptions {
      language
      value
    }
    shortDescriptions {
      language
      value
    }
    manufacturer
    manufacturerCode
    inventory {
      totalQuantity
    }
    price(input: { taxZone: "NL" }) {
      gross
      net
    }
    categoryPath {
      name(language: "NL") {
        value
      }
    }
    media {
      images(search: { sort: ASC, offset: 5 }) {
        itemsFound
        items {
          alt(language: "NL") {
            value
          }
          imageVariants(
            input: {
              transformations: {
                name: "large"
                transformation: {
                  width: 240
                  height: 240
                  fit: BOUNDS
                  bgColor: "transparent"
                  canvas: { width: 240, height: 240 }
                }
              }
            }
          ) {
            url
          }
        }
      }
    }
  }
}
```

**Variables:**

```json
{
  "productId": 45,
  "language": "NL"
}
```

**Expected result:**

```json
{
  "data": {
    "product": {
      "productId": 45,
      "sku": "GT-HGW1",
      "class": "PRODUCT",
      "categoryId": 1736,
      "names": [{ "language": "NL", "value": "Hidden Glow Wall Washer" }],
      "descriptions": [
        {
          "language": "NL",
          "value": "<p>Designed to provide soft, ambient lighting seamlessly integrated into walls</p>"
        }
      ],
      "shortDescriptions": [
        {
          "language": "NL",
          "value": "<p>Designed to provide soft, ambient lighting seamlessly integrated into walls</p>"
        }
      ],
      "manufacturer": "ProLight Solutions",
      "manufacturerCode": "GT-HGW1",
      "inventory": { "totalQuantity": 278 },
      "price": { "gross": 342.54, "net": 414.47 },
      "categoryPath": [
        { "name": [{ "value": "PDM" }] },
        { "name": [{ "value": "Recessed" }] }
      ],
      "media": {
        "images": {
          "itemsFound": 1,
          "items": [
            {
              "alt": [],
              "imageVariants": [{ "url": "https://media.helice.cloud/..." }]
            }
          ]
        }
      }
    }
  }
}
```

Descriptions can contain HTML. The `categoryPath` returns the full breadcrumb from root to the product's category.

## Search products

Use the same `products` query with a `term` to search across product names, SKUs, descriptions and manufacturer codes.

```graphql
query SearchProducts($input: ProductSearchInput) {
  products(input: $input) {
    page
    itemsFound
    pages
    items {
      ... on Cluster {
        clusterId
        names {
          value
        }
        class
        slugs {
          value
        }
        defaultProduct {
          productId
          sku
          names(language: "NL") {
            value
          }
          price(input: { taxZone: "NL" }) {
            gross
            net
          }
        }
      }
      ... on Product {
        class
        productId
        sku
        slugs {
          value
        }
        names(language: "NL") {
          value
        }
        price(input: { taxZone: "NL" }) {
          gross
          net
        }
      }
    }
  }
}
```

**Variables:**

```json
{
  "input": {
    "language": "NL",
    "term": "panel",
    "searchFields": [
      {
        "fieldNames": [
          "NAME",
          "SKU",
          "DESCRIPTION",
          "MANUFACTURER",
          "MANUFACTURER_CODE"
        ],
        "boost": 1
      }
    ],
    "sortInputs": [
      {
        "field": "LAST_MODIFIED_AT",
        "order": "DESC"
      }
    ],
    "page": 1,
    "offset": 24
  }
}
```

**Expected result:**

```json
{
  "data": {
    "products": {
      "page": 1,
      "itemsFound": 3,
      "pages": 1,
      "items": [
        {
          "class": "PRODUCT",
          "productId": 30,
          "sku": "EL-UPL01",
          "slugs": [{ "value": "ultrapanel-led-panel-light" }],
          "names": [{ "value": "UltraPanel LED Panel Light" }],
          "price": { "gross": 89.99, "net": 108.89 }
        },
        {
          "class": "PRODUCT",
          "productId": 27,
          "sku": "CL-LP01",
          "slugs": [{ "value": "cosmopanel-led-light" }],
          "names": [{ "value": "CosmoPanel LED Light" }],
          "price": { "gross": 74.99, "net": 90.74 }
        }
      ]
    }
  }
}
```

You can expand the `searchFields` list to include more fields like `SHORT_DESCRIPTION`, `KEYWORDS`, `EAN_CODE` and `SUPPLIER_CODE` depending on how broad you want the search to be.

## Explore the full schema

These are simplified versions of what a production frontend typically queries. The GraphQL API offers many more fields and query options:

- [GraphQL Explorer](/reference/graphql/explorer) lets you run queries interactively against the API
- [GraphQL Reference](/reference/graphql) has the full schema documentation with all types and fields

## What's next

Continue to [Create an order](/getting-started/build-a-frontend/using-your-own-framework/create-an-order) to build a checkout flow.

---

## Create an Order

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-your-own-framework/create-an-order

# Create an Order

Walk through the cart-to-order flow using GraphQL mutations. By the end of this page you will have created a cart, added a product, set addresses, chosen a payment method and converted it into an order.

## The flow

Creating an order in Propeller follows five steps:

1. **Start a cart** with `cartStart`
2. **Add items** with `cartAddItem`
3. **Set addresses** with `cartUpdateAddress`
4. **Choose payment and shipping** with `cartUpdate`
5. **Process the cart into an order** with `cartProcess`

Each step returns the updated cart so you can display the current state to the user.

## Start a cart

Create an empty cart. For an anonymous session you only need a language. For B2B, pass `contactId` and `companyId` to get customer-specific pricing.

```graphql
mutation StartCart($input: CartStartInput) {
  cartStart(input: $input) {
    cartId
    channelId
    items {
      productId
      quantity
    }
    total {
      subTotal
      totalGross
    }
  }
}
```

**Variables:**

```json
{
  "input": {
    "language": "NL"
  }
}
```

**Expected result:**

```json
{
  "data": {
    "cartStart": {
      "cartId": "019c873a-92ac-7993-b787-6d50d24f44ac",
      "channelId": 1,
      "items": [],
      "total": {
        "subTotal": 0,
        "totalGross": 50
      }
    }
  }
}
```

Save the `cartId`. You will pass it as the `id` argument to every subsequent mutation.

## Add items to the cart

Add a product by its `productId` (from the catalog query on the previous page). You can set the quantity and optionally pass a `clusterId` for cluster products.

```graphql
mutation AddItem($id: String!, $input: CartAddItemInput!) {
  cartAddItem(id: $id, input: $input) {
    cartId
    items {
      itemId
      productId
      quantity
      price
      totalPrice
    }
    total {
      subTotal
      totalNet
      totalGross
    }
  }
}
```

**Variables:**

```json
{
  "id": "019c873a-92ac-7993-b787-6d50d24f44ac",
  "input": {
    "productId": 45,
    "quantity": 2
  }
}
```

**Expected result:**

```json
{
  "data": {
    "cartAddItem": {
      "cartId": "019c873a-92ac-7993-b787-6d50d24f44ac",
      "items": [
        {
          "itemId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "productId": 45,
          "quantity": 2,
          "price": 342.54,
          "totalPrice": 685.08
        }
      ],
      "total": {
        "subTotal": 685.08,
        "totalNet": 841.05,
        "totalGross": 695.08
      }
    }
  }
}
```

Each item gets an `itemId` (UUID). Use this to update or remove items later with `cartDeleteItem`.

## Set addresses

Set the invoice and delivery addresses. Call `cartUpdateAddress` once for each address type.

**Invoice address:**

```graphql
mutation SetInvoiceAddress($id: String!, $input: CartUpdateAddressInput!) {
  cartUpdateAddress(id: $id, input: $input) {
    cartId
    invoiceAddress {
      firstName
      lastName
      street
      number
      postalCode
      city
      country
    }
  }
}
```

**Variables:**

```json
{
  "id": "019c873a-92ac-7993-b787-6d50d24f44ac",
  "input": {
    "type": "INVOICE",
    "firstName": "Lisa",
    "lastName": "de Vries",
    "street": "Keizersgracht",
    "number": "100",
    "postalCode": "1015 AA",
    "city": "Amsterdam",
    "country": "NL",
    "email": "lisa@brouwerindustrie.nl"
  }
}
```

**Delivery address:**

Use the same mutation with `"type": "DELIVERY"`. If the delivery address is the same as the invoice address, you still need to set both.

```json
{
  "id": "019c873a-92ac-7993-b787-6d50d24f44ac",
  "input": {
    "type": "DELIVERY",
    "firstName": "Lisa",
    "lastName": "de Vries",
    "street": "Keizersgracht",
    "number": "100",
    "postalCode": "1015 AA",
    "city": "Amsterdam",
    "country": "NL",
    "email": "lisa@brouwerindustrie.nl"
  }
}
```

## Choose payment and shipping

First, query the cart to see which payment methods are available. Then update the cart with your selection.

**Check available payment methods:**

```graphql
query GetCartPayMethods($id: String!) {
  cart(id: $id) {
    cartId
    payMethods {
      code
      name
      price
    }
  }
}
```

**Expected result:**

```json
{
  "data": {
    "cart": {
      "cartId": "019c873a-92ac-7993-b787-6d50d24f44ac",
      "payMethods": [
        { "code": "IDEAL", "name": "Ideal", "price": 0 },
        { "code": "CREDITCARD", "name": "Visa", "price": 0 },
        { "code": "REKENING", "name": "On account", "price": 0 }
      ]
    }
  }
}
```

**Set payment and shipping method:**

```graphql
mutation UpdateCart($id: String!, $input: CartUpdateInput!) {
  cartUpdate(id: $id, input: $input) {
    cartId
    paymentData {
      method
    }
    postageData {
      method
    }
    total {
      subTotal
      totalNet
      totalGross
    }
  }
}
```

**Variables:**

```json
{
  "id": "019c873a-92ac-7993-b787-6d50d24f44ac",
  "input": {
    "paymentData": {
      "method": "IDEAL"
    },
    "postageData": {
      "method": "standard"
    }
  }
}
```

## Process the cart into an order

Convert the cart into a finalized order. Pass an `orderStatus` to set the initial status of the order.

```graphql
mutation ProcessCart($id: String!, $input: CartProcessInput!) {
  cartProcess(id: $id, input: $input) {
    cartOrderId
    cart {
      cartId
      orderStatus
    }
    order {
      id
      uuid
      status
      type
      createdAt
      total {
        gross
        net
      }
    }
  }
}
```

**Variables:**

```json
{
  "id": "019c873a-92ac-7993-b787-6d50d24f44ac",
  "input": {
    "orderStatus": "NEW",
    "language": "NL"
  }
}
```

**Expected result:**

```json
{
  "data": {
    "cartProcess": {
      "cartOrderId": 277,
      "cart": {
        "cartId": "019c873a-92ac-7993-b787-6d50d24f44ac",
        "orderStatus": "NEW"
      },
      "order": {
        "id": 277,
        "uuid": "019c873b-f7ed-72fe-83a3-6d8b9d84f9a7",
        "status": "NEW",
        "type": "dropshipment",
        "createdAt": "2026-02-22T21:23:00.402Z",
        "total": {
          "gross": 695.08,
          "net": 841.05
        }
      }
    }
  }
}
```

The order is now created. The `order.id` is the order number you can use to look it up later.

## What's next

Continue to [What's next](/getting-started/build-a-frontend/using-your-own-framework/whats-next) for links to more advanced frontend features like customer authentication, quote requests and order history.

---

## Using your own Framework

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-your-own-framework

# Using your own Framework

Build a frontend using Propeller's GraphQL API directly, with your own framework and architecture.

## When to choose this track

This track is for developers who want to work directly with the GraphQL API without using the Storefront SDK. Use this approach when you:

- Want to integrate Propeller into an existing frontend application
- Need a completely custom architecture
- Prefer to write all GraphQL queries yourself

The [Storefront SDK track](/getting-started/build-a-frontend/using-the-storefront-sdk) provides a faster path with pre-built services and UI components that work across frameworks.

## What you'll build

By the end of this track, you will have:

1. An authenticated connection to Propeller's GraphQL API
2. A product listing page that queries real data
3. A basic order creation flow using GraphQL mutations

## Steps

1. [Authenticate](/getting-started/build-a-frontend/using-your-own-framework/authenticate) — connect to the GraphQL API and make your first query
2. [Build a catalog page](/getting-started/build-a-frontend/using-your-own-framework/build-a-catalog-page) — fetch products, search and build a product listing
3. [Create an order](/getting-started/build-a-frontend/using-your-own-framework/create-an-order) — build a cart and submit an order
4. [What's next](/getting-started/build-a-frontend/using-your-own-framework/whats-next) — explore advanced features and frontend guides

---

## What's Next

URL: https://docs.propeller-commerce.com/getting-started/build-a-frontend/using-your-own-framework/whats-next

# What's Next

You've connected to the GraphQL API, queried products and created an order. Here's where to go from here.

## Dive deeper into frontend development

The [Frontend development guides](/frontend) cover each area in detail:

- **Products & Catalog** — product model, categories, search and media
- **Pricing & Discounts** — pricing layers, customer-specific pricing, tiered pricing, promotions
- **Cart & Checkout** — order lifecycle, cart management, checkout flows, payments
- **Customers & Companies** — B2B account models, authentication, company management
- **Quotes & RFQ** — request-for-quote flows, negotiation, quote-to-order conversion

## Explore the API

- [GraphQL Explorer](/reference/graphql/explorer) — run queries interactively
- [GraphQL Reference](/reference/graphql) — full schema with all types, queries and mutations

## Connect business systems

Most B2B projects also need backend integrations to keep data in sync:

- [Build an Integration](/getting-started/build-an-integration) — sync products, orders and customers between Propeller and your ERP, PIM or CRM using the REST API

## Consider the Storefront SDK

If you find yourself rebuilding common B2B patterns from scratch, the [Storefront SDK](/getting-started/build-a-frontend/using-the-storefront-sdk) provides pre-built components for product listings, cart, checkout, authentication and account management. It can save significant development time.

---

## Authenticate

URL: https://docs.propeller-commerce.com/getting-started/build-an-integration/authenticate

# Authenticate

You need client credentials from the Backoffice to authenticate with the REST API. In this page you request an access token and use it to make your first API call.

## Prerequisites

- Propeller REST API credentials (`client_id` and `client_secret`), created in the Backoffice under **Admin > API Key Management** (see [Environments and Access](/getting-started/platform-architecture/environments-and-access))

## Step 1: Request an access token

```bash
curl -X POST https://api.helice.cloud/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "client_id=your_client_id&client_secret=your_client_secret&grant_type=client_credentials"
```

Replace `your_client_id` and `your_client_secret` with the credentials from your Backoffice.

**Expected response:**

```json
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwic2NvcGUiOiJwcm9maWxlIiwiaWF0IjoxNzE2MjM5MDIyLCJleHAiOjE3MTYyNDA4MjJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_in": 1800,
  "token_type": "Bearer",
  "scope": "profile"
}
```

The token is valid for 30 minutes.

## Step 2: Make an authenticated request

Use the token to fetch a product by SKU from the REST API:

```bash
curl -X GET https://api.helice.cloud/v2/products/sku/QSFP-40G-SR4 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"
```

Replace `YOUR_ACCESS_TOKEN` with the `access_token` value from step 1. Replace `QSFP-40G-SR4` with a SKU that exists in your environment.

**Expected response:**

```json
{
  "data": {
    "id": 6,
    "sku": "QSFP-40G-SR4",
    "names": [
      { "language": "NL", "value": "QSFP-40G-SR4 Transceiver Module" }
    ],
    "status": "A",
    "manufacturer": "Cisco",
    "supplier": "Intern",
    "taxCode": "H",
    "taxPercentage": 21,
    "minimumQuantity": 1,
    "unit": 1
  },
  "messages": [],
  "total": 1
}
```

If you see product data, authentication is working. You are ready to start building your integration.

## Next steps

- [Authentication and security](/integrations/integration-patterns/authentication-and-security) for token renewal patterns and production auth guidance
- [Get Access Token endpoint](/reference/rest/endpoints/get-access-token) for the full endpoint specification and error codes

---

## Import a Catalog Tree

URL: https://docs.propeller-commerce.com/getting-started/build-an-integration/import-a-catalog-tree

# Import a Catalog Tree

Push your ERP category structure into Propeller using the REST API. By the end of this page you will have a category tree with a root category and subcategories.

## Prerequisites

- REST API credentials (`client_id` and `client_secret`)
- An access token ([Authenticate](/getting-started/build-an-integration/authenticate))

## Create a root category

Use `POST /categories/` to create a single category. The `sourceId` and `source` fields let you map the category to its identifier in your ERP.

```bash
curl -X POST https://api.helice.cloud/v2/categories/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "names": [
      {"language": "EN", "value": "Industrial Valves"}
    ],
    "sourceId": "CAT-100",
    "source": "ERP"
  }'
```

Omitting the `parent` field creates the category as a root category at the top level of the catalog tree. The response returns the new category with its Propeller `id`.

```json
{
  "data": {
    "names": [{"language": "EN", "value": "Industrial Valves"}],
    "sourceId": "CAT-100",
    "source": "ERP",
    "id": 1829
  },
  "messages": ["Category created successfully"],
  "total": 1
}
```

## Add subcategories

Create subcategories by referencing the parent category in the `parent` field.

```bash
curl -X POST https://api.helice.cloud/v2/categories/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "names": [
      {"language": "EN", "value": "Ball Valves"}
    ],
    "parent": {"id": 1771},
    "sourceId": "CAT-110",
    "source": "ERP"
  }'
```

Repeat for each subcategory. For example, create "Gate Valves" with `sourceId: "CAT-120"` under the same parent.

## Import a full tree with the bulk endpoint

For ERP sync the bulk endpoint is more practical. `POST /categories/bulk/sourceId` creates or updates categories identified by `sourceId` and `source`. If a category with the given `sourceId` already exists it updates the record. If not it creates a new one.

The key advantage is that the `parent` field references other categories by `sourceId` instead of Propeller ID. This means you can send the full tree in one request without knowing any Propeller IDs.

```bash
curl -X POST https://api.helice.cloud/v2/categories/bulk/sourceId \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      {
        "sourceId": "CAT-100",
        "source": "ERP",
        "names": [
          {"language": "EN", "value": "Industrial Valves"}
        ]
      },
      {
        "sourceId": "CAT-110",
        "source": "ERP",
        "names": [
          {"language": "EN", "value": "Ball Valves"}
        ],
        "parent": {"sourceId": "CAT-100"}
      },
      {
        "sourceId": "CAT-120",
        "source": "ERP",
        "names": [
          {"language": "EN", "value": "Gate Valves"}
        ],
        "parent": {"sourceId": "CAT-100"}
      }
    ]
  }'
```

The subcategories reference their parent by `sourceId` (`"parent": {"sourceId": "CAT-100"}`), so no Propeller IDs are needed. Running this request again with updated names will update the existing categories instead of creating duplicates.

## Directives

The bulk endpoint supports `directives` to control update behavior:

- `skipIfNotEmpty` preserves fields that already have a value, useful when category names or descriptions have been edited directly in Propeller
- `skipMoveOnUpdate` prevents moving a category to a different parent on update

See the [Bulk Categories endpoint](/reference/rest/endpoints/product-management/bulk-categories) for the full directives documentation.

## What's next

Continue to [Search orders](/getting-started/build-an-integration/search-orders) to learn how to export orders for ERP processing.

---

## Build an Integration

URL: https://docs.propeller-commerce.com/getting-started/build-an-integration

# Build an Integration

Connect business systems to Propeller using the REST API. Sync products, pricing, orders, customers and inventory between Propeller and your ERP, PIM, CRM or warehouse system.

## What the REST API is for

The REST API is designed for system-to-system communication. Use it to:

- **Import products** — push product data from a PIM or ERP into Propeller
- **Sync pricing** — keep pricing in Propeller up-to-date with your ERP
- **Export orders** — pull orders from Propeller for fulfillment processing
- **Manage customers** — sync companies, contacts and addresses with your CRM
- **Update inventory** — push stock levels from your warehouse system

See [API Landscape](/getting-started/platform-architecture/api-landscape) for guidance on when to use the REST API vs the GraphQL API.

## Steps

This track walks you through the key integration patterns:

1. [Authenticate](/getting-started/build-an-integration/authenticate) — get an access token and make your first API call
2. [Import a catalog tree](/getting-started/build-an-integration/import-a-catalog-tree) — import categories from your ERP into Propeller
3. [Search orders](/getting-started/build-an-integration/search-orders) — search and export orders for ERP processing
4. [What's next](/getting-started/build-an-integration/whats-next) — explore advanced integration patterns

---

## Search Orders

URL: https://docs.propeller-commerce.com/getting-started/build-an-integration/search-orders

# Search Orders

Search and export orders from Propeller to your ERP or fulfillment system. By the end of this page you will know how to retrieve orders by status and other filters.

## Prerequisites

- REST API credentials (`client_id` and `client_secret`)
- An access token ([Authenticate](/getting-started/build-an-integration/authenticate))

## Search for new orders

Use `POST /orders/search` to find orders matching your criteria. A typical ERP export flow searches for confirmed orders that have not yet been exported.

```bash
curl -X POST "https://api.helice.cloud/v2/orders/search?expands=ORDER_ITEMS" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": ["CONFIRMED"],
    "page": 1,
    "offset": 25
  }'
```

The `expands` query parameter controls which related data is included in the response. Available options: `ORDER_ITEMS`, `ADDRESSES`, `SOURCES`, `SHIPMENTS`, `SHIPMENT_ITEMS`, `TRACK_AND_TRACES`. Multiple values can be comma separated.

### Available filters

All filters are optional. If no filters are provided the endpoint returns all accessible orders with default pagination.

| Filter | Type | Description |
|---|---|---|
| `statuses` | string | Order status values, e.g. `["CONFIRMED"]` |
| `exportStatuses` | string | Export state: `"exported"`, `"finished"`, `"failed"` or empty string |
| `types` | string | `dropshipment`, `purchase`, `quotation`, `stock` |
| `userIds` | integer | Filter by user IDs who placed the orders |
| `companyIds` | integer | Filter by company IDs |
| `term` | string | Free text search across order fields |
| `termFields` | string | Fields to search, e.g. `["recipientCompany", "email"]` |
| `createdAt` | object | Date range: `{"from": "...", "to": "..."}` |
| `lastModifiedAt` | object | Date range: `{"from": "...", "to": "..."}` |
| `page` | integer | Page number (starts at 1) |
| `offset` | integer | Items per page (defaults to 12) |
| `sortInputs` | object | Sort by field and direction |

## Read the response

The response contains an `items` array with matching orders and pagination metadata.

```json
{
  "items": [
    {
      "id": 182,
      "uuid": "019cfbf9-4d07-7d9f-866e-897e497d5a01",
      "channelId": 1,
      "status": "NEW",
      "type": "dropshipment",
      "email": "sophie@acme.nl",
      "currency": "EUR",
      "language": "NL",
      "date": "2026-03-17T13:25:45.538Z",
      "source": "webshop",
      "debtorId": "129654000",
      "companyId": 131,
      "postageData": {
        "method": "REGULAR",
        "taxPercentage": 21,
        "gross": 15,
        "net": 18.15,
        "tax": 3.15,
        "overruled": "Y",
        "carrier": "DHL"
      },
      "paymentData": {
        "method": "REKENING",
        "status": "UNKNOWN",
        "overruled": "N"
      },
      "total": {
        "gross": 58.95,
        "net": 71.33,
        "tax": 12.38,
        "discountValue": 0,
        "discountType": "N"
      },
      "items": [
        {
          "sku": "838519",
          "name": "HP 117A Toner Cartridge Black",
          "quantity": 1,
          "price": 43.95,
          "priceNet": 53.18,
          "costPrice": 23.56,
          "taxPercentage": 21,
          "supplier": "HP Official Store",
          "manufacturer": "HP"
        }
      ],
      "lastModifiedAt": "2026-03-17T13:25:46.005Z"
    }
  ],
  "itemsFound": 42,
  "offset": 25,
  "page": 1,
  "pages": 2,
  "start": 1,
  "end": 25
}
```

Each order includes `postageData`, `paymentData` and `total`. When you include `ORDER_ITEMS` in the expands parameter each order also contains its line items in the `items` array. Additional expand options include `ADDRESSES`, `SOURCES`, `SHIPMENTS`, `SHIPMENT_ITEMS` and `TRACK_AND_TRACES`.

## Process and mark as exported

After processing an order in your ERP you should update its export status in Propeller. This prevents the order from appearing in your next search. Use the [Update Order](/reference/rest/endpoints/orders/list-orders) endpoint to set the export status on the order.

See the [Search Orders endpoint](/reference/rest/endpoints/orders/list-orders) for the full request and response schemas.

## What's next

Continue to [What's next](/getting-started/build-an-integration/whats-next) for links to advanced integration guides.

---

## What's Next

URL: https://docs.propeller-commerce.com/getting-started/build-an-integration/whats-next

# What's Next

You've authenticated with the REST API, imported a catalog tree and searched orders. Here's where to go from here.

## Dive deeper into integrations

The [Integration development guides](/integrations) cover each area in detail:

- **Integration Patterns** — architecture, sync strategies, error handling, webhooks
- **Product Data** — syncing attributes, categories, media and bulk operations
- **Pricing Data** — price lists, customer-specific pricing, tax configuration
- **Order Flow** — order lifecycle, status updates, returns, quote-to-order
- **Customer & Company Data** — companies, contacts, addresses, usergroups
- **Inventory** — stock management, warehouse integration, availability

## Explore the API

- [REST API Explorer](/reference/rest/explorer) — browse and test endpoints interactively
- [REST API Reference](/reference/rest) — full endpoint documentation with schemas
- [Authentication and security](/integrations/integration-patterns/authentication-and-security) — token management and security

## Build a frontend

If your project also includes a customer-facing frontend:

- [Using the Storefront SDK](/getting-started/build-a-frontend/using-the-storefront-sdk) — guided approach with Next.js and pre-built components
- [Using your own Framework](/getting-started/build-a-frontend/using-your-own-framework) — use the GraphQL API with Vue, Angular, Svelte or any other technology

---

## Getting Started

URL: https://docs.propeller-commerce.com/getting-started

# Getting Started

Propeller is a B2B commerce platform with two API surfaces. The **GraphQL API** is for building customer-facing frontends. The **REST API** is for connecting business systems. Most implementations use both.

## Understand the platform

New to Propeller? Start here to learn how the platform works, what the core data model looks like and how the APIs relate to each other. This takes about 10 minutes to read and gives you the mental model you need before writing any code.

[Platform Architecture &rarr;](/getting-started/platform-architecture)

## See Propeller in action

The fastest way to experience Propeller's B2B capabilities. Install the WordPress Plugin and explore a working customer portal with ordering, quotes and company accounts. No frontend code required.

[WordPress Plugin &rarr;](/getting-started/wordpress-plugin)

## Build a B2B frontend

Build a custom storefront, customer portal or dealer portal. Choose between the Storefront SDK for a guided approach with pre-built components, or connect directly to the GraphQL API with your own framework.

[Build a Frontend &rarr;](/getting-started/build-a-frontend)

## Connect your business systems

Sync products, pricing, orders, customers and inventory between Propeller and your ERP, PIM, CRM or other backend systems using the REST API.

[Build an Integration &rarr;](/getting-started/build-an-integration)

---

## API Landscape

URL: https://docs.propeller-commerce.com/getting-started/platform-architecture/api-landscape

# API Landscape

Propeller has two API surfaces that serve fundamentally different use cases. By the end of this page you will know which API to use for any given task in your implementation.

## GraphQL API (for frontends)

The **GraphQL API** is designed for building customer-facing experiences: webshops, customer portals, dealer portals and any interface where end users browse products, place orders or manage their accounts.

**Use GraphQL when you need to:**
- Display products, categories, pricing and media
- Manage shopping carts and checkout flows
- Handle customer authentication and account features
- Build quote request (RFQ) flows
- Create order history and reorder functionality
- Build search and filtering interfaces

**Why GraphQL for frontends?** GraphQL lets you request exactly the data you need in a single query, which is ideal for frontend performance. You avoid over-fetching (getting fields you don't display) and under-fetching (needing multiple round-trips). A single query can retrieve nested, related data that would otherwise require multiple sequential REST calls.

The Storefront SDK provides a Next.js boilerplate with pre-built UI components that use the GraphQL API. It is the recommended starting point for new frontend projects.

## REST API (for integrations)

The **REST API** is designed for connecting business systems: ERP, PIM, CRM, warehouse management and other backend applications that need to exchange data with Propeller.

**Use REST when you need to:**
- Import or sync products, categories and attributes from an external system
- Sync pricing from an ERP
- Export orders for fulfillment
- Sync customer and company data with a CRM
- Update inventory levels from a warehouse system
- Perform bulk data operations

**Why REST for integrations?** REST provides predictable, resource-oriented endpoints optimized for bulk operations and system-to-system communication. Each resource (products, orders, companies, etc.) has standard CRUD operations with consistent patterns.

## When to use which

| Scenario | API | Why |
|----------|-----|-----|
| Display product catalog in a webshop | GraphQL | Flexible queries for UI rendering |
| Import 10,000 products from PIM | REST | Bulk endpoints designed for batch operations |
| Add item to shopping cart | GraphQL | Frontend interaction, needs low latency |
| Sync order status to ERP | REST | System-to-system data exchange |
| Show customer-specific pricing | GraphQL | Frontend needs to display prices per user |
| Update inventory from warehouse | REST | Backend system pushing data to Propeller |
| Build a search/filter interface | GraphQL | Complex queries with nested data |
| Create companies and contacts from CRM | REST | Bulk entity management |

Both APIs read from and write to the same Propeller platform. A product created via REST is immediately queryable via GraphQL. An order placed via GraphQL is immediately available via REST. There is no sync delay between the two surfaces.

## MCP Server (for AI-assisted development)

Propeller provides a **Model Context Protocol (MCP) server** that connects to the GraphQL API. MCP is an open standard that lets AI assistants and LLMs interact with external tools and data sources.

The Propeller MCP server allows an AI assistant to introspect the GraphQL schema, discover available queries and mutations, and execute them dynamically. This makes it useful for exploring what the API offers, validating queries against the live schema and prototyping integrations through natural language.

You can connect the MCP server to any MCP-compatible client such as Claude Desktop, Cursor or your own application. Reach out to your Propeller account manager for access.

## Next: Environments and Access

Get your API credentials and make your first connection.

[Environments and Access &rarr;](/getting-started/platform-architecture/environments-and-access)

---

## Core Concepts

URL: https://docs.propeller-commerce.com/getting-started/platform-architecture/core-concepts

# Core Concepts

The data model concepts you need before working with Propeller's APIs. This page covers the building blocks you will encounter in every implementation. Domain-specific concepts like pricing layers, quote flows and orderlists are covered in the relevant guides once you need them.

## Tenants and channels

A **tenant** is the foundation of all data in Propeller. Everything lives inside a tenant: products, prices, companies, contacts, orders, quotes and all other commercial data. Each Propeller environment operates within a single tenant.

A **channel** represents a specific frontend or sales experience, such as a webshop, a B2B dealer portal or a mobile ordering app. Each channel belongs to one tenant, and a tenant can have multiple channels.

Channels handle presentation-specific configuration: SEO settings, templates, catalog structure, languages and anonymous user behavior. The underlying commercial data (products, pricing, customers, orders) is shared at the tenant level, while each channel maintains its own customer experience.

**Example:** a single tenant powering three channels:
- An Amazon Business Germany storefront
- An acme-us.com dealer portal
- An iOS/Android mobile ordering app

All three channels share the same product catalog, pricing rules and customer data, but each presents a tailored experience to its audience.

## Products and clusters

The basis of commerce in Propeller is **products**. A product is a sellable item with its own SKU, price and stock level.

A **cluster** groups related products together as variants of a single item. A cluster can also have **cluster options**, which are add-on product groups like insurance, accessories or extended warranties that customers can select alongside the main product.

## Categories

**Categories** organize products into a hierarchical navigation structure. A product belongs to at most one primary category; a product created without a category is a floating product. Each category has at most one parent category; a category created without a parent is a root category. There is no limit to the number of hierarchy levels.

## Customers, companies and contacts

Propeller distinguishes between B2C and B2B account models:

- A **customer** is a B2C buyer
- A **company** is a B2B business entity with addresses, pricing and settings
- A **contact** is a person associated with a company who can place orders and quotes

## Orders

An **order** is an object that can be created from a cart or through other means such as a direct API call. It follows a lifecycle defined by its order status. In B2B scenarios this lifecycle often includes a **quote** flow: a contact submits a quote request, a sales representative provides pricing and upon acceptance the quote converts into a confirmed order that moves to fulfillment.

## Concepts you will encounter later

The following concepts become relevant as you go deeper into specific implementation areas. Each is covered in detail in the relevant guide.

**Pricing and pricesheets.** Propeller's pricing model uses pricesheets, which are pricing configurations assigned to customers, customer groups or channels. This enables customer-specific contract pricing, tiered volume pricing and promotions.

**Orderlists.** An orderlist is a customer-specific catalog that controls which products are visible and orderable for specific companies or customers.

**Attributes.** Attributes extend the default properties of products, categories, customers and other entities. Propeller supports six attribute types: Text, Integer, Decimal, Enum, DateTime and Color. Enum attributes reference a **valueset**, a predefined list of allowed values. Covered in the [product model guide](/frontend/domain-guides/products-and-catalog/understanding-products-and-categories).

## Next: API Landscape

Now that you know the core data model, learn which API to use for what.

[API Landscape &rarr;](/getting-started/platform-architecture/api-landscape)

---

## Environments and Access

URL: https://docs.propeller-commerce.com/getting-started/platform-architecture/environments-and-access

# Environments and Access

How to get access to Propeller's APIs and what environments are available. By the end of this page you will know which credentials you need and how authentication works for both APIs.

## API endpoints

| API | Endpoint |
|-----|----------|
| GraphQL v2 | `https://api.helice.cloud/v2/graphql` |
| REST v2 | `https://api.helice.cloud/v2/{resource}` |

## Authentication

Both APIs require authentication, but they use different mechanisms.

### GraphQL API

GraphQL requests are authenticated using an **API key** sent as a header:

```
apiKey: YOUR_API_KEY
```

For frontend applications that need user-specific data (pricing, order history, account features), you also need a **user session token** obtained through the login mutation.

### REST API

The REST API uses **OAuth 2.0 client credentials**. You authenticate by sending your Client ID and Client Secret to the token endpoint, which returns a time-limited access token:

```bash
curl -X POST https://api.helice.cloud/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"
```

The returned `access_token` is valid for 30 minutes and must be included as a Bearer token in subsequent requests.

## Creating your API keys

You create API keys yourself in the Backoffice under **Admin > API Key Management**. Viewing the page requires the API Key role and creating or deleting keys requires Owner access on that role. For the step-by-step guide see [API Keys](https://help.propeller-commerce.com/commerce-hub-admin/api-keys) in the business documentation.

- **GraphQL keys** have a name, an optional channel association and one or more roles. Each role combines a role definition (for example Product Data, Order Data or Pricing) with an access level (Viewer, Editor or Owner). The generated API key is shown after saving, and the name, roles and channel can be changed later.
- **REST keys** have a name and an active toggle. Saving the key generates the Client ID and Client Secret used in the OAuth flow.

New keys are inactive by default. Set a key to active before using it.

You can also manage keys programmatically with the GraphQL mutations [`gqlApiKeyCreate`](/reference/graphql/mutations/gql-api-key-create) and [`restApiKeyCreate`](/reference/graphql/mutations/rest-api-key-create), with matching [update](/reference/graphql/mutations/gql-api-key-update) and delete mutations for both key types.

The WordPress plugin requires two separate GraphQL API keys: one for general storefront operations and one for order processing. See [General settings](/frontend/wordpress-plugin/general-settings) for details.

If you do not have Backoffice access yet, contact your Propeller account manager.

## You are ready to start building

You now have the platform mental model, understand which API to use for what and know how authentication works. Choose your next step:

- [WordPress Plugin](/getting-started/wordpress-plugin): see Propeller in action with a pre-built B2B portal (fastest way to explore the platform)
- [Build a Frontend](/getting-started/build-a-frontend): build a custom frontend using the Storefront SDK or your own framework
- [Build an Integration](/getting-started/build-an-integration): connect business systems using the REST API

---

## Platform Architecture

URL: https://docs.propeller-commerce.com/getting-started/platform-architecture

# Platform Architecture

This section gives you the mental model you need before you start building. By the end of these three pages you will understand Propeller's data model, know which API to use for what and have your API credentials ready.

<ThemedImage
  alt="Propeller platform architecture diagram showing the GraphQL API for frontends, REST API for business system integrations and MCP Server for AI agents"
  sources={{
    light: '/img/platform-architecture.svg',
    dark: '/img/platform-architecture-dark-mode.svg',
  }}
/>

## API surfaces

The **GraphQL API** is the frontend API. Partners use it to build customer-facing experiences: webshops, B2B customer portals and self-service ordering interfaces. The Storefront SDK (Next.js) and WordPress Plugin are both built on the GraphQL API. Partners building fully custom frontends in other frameworks also use GraphQL directly.

The **REST API** is the integration API. Partners use it to connect Propeller with backend business applications: ERP systems, PIM, CRM and other operational tools. These integrations handle product sync, order flow, inventory management, customer data and pricing.

The **MCP Server** is the AI agent API. It lets AI agents and other MCP-compatible hosts interact with Propeller data programmatically.

## Platform components

| Component | Type | Description |
|---|---|---|
| **GraphQL API** | Open API | GraphQL interface for flexible data querying and mutations |
| **REST API** | Open API | REST endpoints for platform integration |
| **MCP Server** | Open API | MCP interface for AI agents and MCP-compatible hosts |
| **Storefront SDK** | NPM Package | SDK built on the GraphQL API with pre-built components |
| **WordPress Plugin** | Frontend Plugin | Plugin for quickly setting up a B2B customer portal on WordPress |
| **Backoffice** | Frontend UI | Platform management interface for B2B commerce logic |
| **Sales Hub** | Frontend UI | Interface for sales reps to manage quotes, orders, companies and contacts |

## How it fits together

Most implementations involve two primary workstreams:

1. **Frontend development** using the GraphQL API (directly or through the Storefront SDK or WordPress Plugin) to build the customer-facing experience
2. **Integration development** using the REST API to keep product data, pricing and orders in sync with backend systems

The AI agent layer is an additional surface that partners can adopt independently of the other two workstreams.

## Next: Core Concepts

Learn the key data model concepts before you start making API calls.

[Core Concepts &rarr;](/getting-started/platform-architecture/core-concepts)

---

## Explore B2B Features

URL: https://docs.propeller-commerce.com/getting-started/wordpress-plugin/explore-b2b-features

# Explore B2B Features

Walk through the B2B features that make Propeller different from a standard webshop. This page guides you through a set of scenarios that demonstrate customer-specific pricing, company accounts, ordering, quoting and portal access control. You are not configuring anything here. You are seeing the platform in action.

Your Propeller environment includes demo data for all the features below. No setup is required.

<details>
<summary>What demo data is used in this walkthrough</summary>

- **Company and contact** — A B2B company with a contact that has login credentials. You can manage companies and contacts through the API or in the Backoffice under Users.
- **Products and clusters** — Products with prices and at least one cluster with variants and optional add-ons. You can manage products and clusters through the API or in the Backoffice under Products.
- **Pricesheet** — A pricesheet assigned to the contact with customer-specific discounts. You can manage pricesheets through the API or in the Backoffice under Pricing.
- **Orderlist** — An orderlist assigned to the contact that limits the visible catalog to a subset of products. You can manage orderlists through the API or in the Backoffice under Users.

</details>

## Portal mode: anonymous vs logged-in

Start by visiting the catalog without logging in.

With a default setting of open portal, without being logged in you can see products, prices and stock. You can add products to the cart and order them.

![Catalog without logging in](/img/wordpress-plugin/catalog-anonymous.png)

## Log in as a B2B contact

Log in using a contact's credentials. After logging in you land on the account dashboard where you can see your quotes, orders and more.

![Login form](/img/wordpress-plugin/login-form.png)

## Browse the catalog and see customer-specific pricing

Navigate to the catalog or search for a product. The prices you see reflect the pricesheet assigned to your contact. Notice the catalog now shows customer-specific pricing and only the products that are part of your orderlist. If a product has bulk or tiered pricing, the product detail page shows a pricing table with the price per quantity tier.

![Catalog with customer-specific pricing](/img/wordpress-plugin/catalog-logged-in.png)

## Configure a cluster product

Navigate to a cluster product. A cluster groups multiple product variants together, for example an LED panel available in different sizes and color temperatures. On the product detail page you see dropdown selectors for each variant attribute. Select different options and the page updates the price, SKU and availability. If the cluster has optional add-on products (cluster options), those appear as additional selections on the same page.

![Cluster product detail page](/img/wordpress-plugin/cluster-product-detail.png)

## Add to cart and place an order

1. Click **Add to cart** on a product detail page. A confirmation popup appears showing the selected product, options and price.

![Add to cart confirmation](/img/wordpress-plugin/add-to-cart-confirmation.png)

2. Open the cart. The order summary shows the subtotal, shipping costs, VAT and total.

![Shopping cart with order summary](/img/wordpress-plugin/shopping-cart.png)

3. Click **Proceed to checkout**. Confirm the invoice and delivery address and select a payment method.

![Checkout with address and payment selection](/img/wordpress-plugin/checkout-address-payment.png)

4. Review the order summary. Add a reference or comment in the notes section if needed and accept the terms.

![Checkout order summary](/img/wordpress-plugin/checkout-summary.png)

5. Click **Place order**. The order confirmation shows the order number, addresses and line items.

![Order confirmation](/img/wordpress-plugin/order-confirmation.png)

## Request a quote

1. Add one or more products to the cart. In the cart, click **Quote request** instead of proceeding to checkout.

![Cart with quote request button](/img/wordpress-plugin/cart-quote-request.png)

2. Confirm or fill in the invoice and delivery details, add an optional note and click **Place quote request**.

![Quote request form](/img/wordpress-plugin/quote-request-form.png)

3. The submitted quote appears in Sales Hub where a sales rep can review the line items, adjust pricing and respond to the customer.

![Quote request in Sales Hub](/img/wordpress-plugin/sales-hub-quote-request.png)

## Manage favorites

Go to your account area and open the favorites section. Click **Create a new list** and give it a name.

![Create a new favorites list](/img/wordpress-plugin/favorites-create-list.png)

On a product detail page, click the heart icon next to the add-to-cart button. Select the list you want to add the product to and confirm.

![Add product to favorites list](/img/wordpress-plugin/product-favorites-dialog.png)

Open the favorites list to see the added products. You can add items from a list directly to the cart.

![Favorites list with product](/img/wordpress-plugin/favorites-list-with-product.png)

## Company account features

The account dashboard shows your company information, open quotes and current orders. Under the personal and company details you can see contact information, tax number, CoC number and debtor ID. The addresses section shows the default invoice and delivery addresses for the company.

If your contact is associated with multiple companies, you can switch between them from the account area.

## Next: What's Next

You have seen Propeller's B2B capabilities in action. Now choose your implementation path.

[What's Next &rarr;](/getting-started/wordpress-plugin/whats-next)

---

## Introduction

URL: https://docs.propeller-commerce.com/getting-started/wordpress-plugin

# WordPress Plugin

The WordPress Plugin is the fastest way to experience Propeller's B2B commerce capabilities. You install it on a WordPress site, connect it to a Propeller environment and get a fully functional B2B customer portal without writing any frontend code. The plugin is open source and available on [GitHub](https://github.com/propeller-commerce/wordpress-v2).

By the end of this Getting Started track you will have a working portal where you can browse products, log in as a B2B contact, see customer-specific pricing, place an order and request a quote.

## What the plugin provides

The plugin delivers a complete B2B ordering experience out of the box.

<details>
<summary>Features included in the plugin</summary>

- A product catalog with filtering, sorting and multiple view modes
- Product detail pages with image galleries, pricing, specifications and downloadable files
- Cluster pages with variant selection and optional add-on products
- A shopping cart with quantity management, discount codes and full order summaries
- Checkout with address forms, payment and carrier selection and delivery date picking
- User accounts with login, registration, address management and company switching
- Order history with search, filtering, return requests and reordering
- Quote request flows with accept and change request actions
- Favorite lists for saving and organizing products
- Budget limits, authorization requests and approval flows
- A configurable portal mode that shows or hides prices and cart actions from anonymous visitors

</details>

The plugin uses the same GraphQL API that the Storefront SDK and custom frontends use. Everything you see in the plugin reflects real Propeller platform capabilities.

## What the plugin is for

Use the WordPress Plugin to evaluate Propeller before committing to a frontend approach. It lets you and your team explore B2B features with real data (or mock data) and understand how the platform handles pricing, ordering, quoting and account management.

For production projects, most partners choose the [Storefront SDK](/getting-started/build-a-frontend/using-the-storefront-sdk/) or build a custom frontend directly on the GraphQL API. Both options give you full control over the user experience. The WordPress Plugin is the starting point, not the only option.

## Next: Install and Configure

Set up the plugin and connect it to your Propeller environment.

[Install and Configure &rarr;](/getting-started/wordpress-plugin/install-and-configure)

---

## Install and Configure

URL: https://docs.propeller-commerce.com/getting-started/wordpress-plugin/install-and-configure

# Install and Configure

Install the WordPress Plugin and connect it to your Propeller environment. By the end of this page you will have a running B2B portal loading products, pricing and account features from Propeller.

## Prerequisites

- A WordPress installation (version 6.2 or higher)
- PHP 8.1 or higher
- Two Propeller GraphQL API keys: one for general storefront operations and one for order processing ([how to get credentials](/getting-started/platform-architecture/environments-and-access))

## Step 1: Install the plugin

There are two ways to install the plugin. Pick whichever suits your setup.

### Option A: Install from WordPress


Option A will be available when the V2 plugin is published to the WordPress plugin directory. For now, use Option B.


1. Go to **Plugins > Add New** in your WordPress admin
2. Search for **Propeller**
3. Click **Install Now** and then **Activate**

### Option B: Install manually

1. Download the plugin from the [Propeller Commerce GitHub](https://github.com/propeller-commerce/wordpress-v2) and upload the folder to `/wp-content/plugins/`
2. Go to **Plugins** in your WordPress admin and activate **Propeller**

### After activation

Go to the **Propeller** page in your WordPress admin. This is where you connect the plugin to your Propeller environment.

## Step 2: Configure the connection

1. Go to **Propeller > General** in your WordPress admin
2. The **API URL** is pre-filled with the Propeller GraphQL endpoint. Leave the default unless you use a custom environment
3. Enter your **API key** for general storefront operations such as catalog browsing, authentication and product data ([how to get one](/getting-started/platform-architecture/environments-and-access))
4. Enter your **Orders API key** for order processing such as cart mutations and placing orders
5. Set the **Channel ID** to match your Propeller channel
6. Set the **Anonymous user ID**. Propeller requires a user context for pricing and availability. This ID determines which prices anonymous visitors see
7. Set the **Catalog root ID**. The plugin starts browsing from this category and shows all its descendants
8. The **Default language** setting does not control the website language. To set the website language, go to **WordPress Settings > General > Site Language**. When you change the site language, product and catalog data is also fetched in that language
9. Set the **Default currency** (for example `EUR`, `USD`). This controls the currency symbol displayed next to prices. It does not convert prices between currencies
10. Click **Save settings**

The Propeller menu also has pages for **Pages**, **Behavior**, **Translations** and **Sitemap**. You can explore these after verifying the shop works. See [General settings](/frontend/wordpress-plugin/general-settings) for a full description of each field.

## Step 3: Add header shortcodes

The plugin creates all commerce pages (login, cart, account, checkout) with the correct shortcodes. However, the header navigation elements are not added automatically. You need to place these shortcodes in your theme's header.

Add the following shortcode blocks to your theme header area using your page builder (WordPress ships with Gutenberg by default, but any page builder works):

- `[menu]` — category navigation menu
- `[search]` — search bar
- `[mini-account]` — account icon and login link
- `[mini-shopping-cart]` — cart icon with item count

These four shortcodes give you a functional shop header with navigation, search, account access and cart.

Without these shortcodes the commerce pages still work (you can access them by typing URLs directly), but the site will not have navigation, search or cart access in the header.

## Step 4: Verify the shop

1. Visit your WordPress site frontend
2. You should see the category navigation in the header (from the `[menu]` shortcode)
3. Navigate to a category page. Products from your Propeller environment should appear
4. Click a product to see the product detail page with pricing

If the catalog is empty, check that your API key is correct, the Channel ID matches a channel with published products and the Catalog root ID points to a category with products in Propeller.

## Good to know

- **Sitemaps** — The plugin generates sitemaps automatically (runs once after midnight). Sitemaps are for SEO only. Your shop works without them and you do not need to wait for the first sitemap run.
- **Translations** — The plugin's default UI labels (buttons, form text) are in English. To change the site language, go to WordPress Settings > General > Site Language. For multi-language setups, see [Translations and valuesets](/frontend/wordpress-plugin/translations-and-valuesets).
- **Default theme** — The plugin works with any WordPress theme, including the default theme (for example Twenty Twenty-Five).

## Next: Explore B2B Features

Your portal is running. Walk through the key B2B features to see what Propeller can do.

[Explore B2B Features &rarr;](/getting-started/wordpress-plugin/explore-b2b-features)

---

## What's Next

URL: https://docs.propeller-commerce.com/getting-started/wordpress-plugin/whats-next

# What's Next

You now have a working B2B portal and have seen how Propeller handles product browsing, customer-specific pricing, ordering, quoting and account management. Everything you saw in the WordPress Plugin is powered by the GraphQL API and is available to any frontend you build.

## Choose your frontend approach

Propeller supports three frontend approaches. Each one uses the same GraphQL API, so the B2B features you just explored are available regardless of which path you choose.

**Storefront SDK (recommended for maximum customization).** The Storefront SDK is a Next.js boilerplate with pre-built UI components. It gives you full control over the user experience while providing a head start on common B2B patterns like authentication, product browsing, cart management and checkout. Choose this if your project requires a fully custom design or advanced frontend logic.

[Build a Frontend with the Storefront SDK &rarr;](/getting-started/build-a-frontend)

**Custom frontend on the GraphQL API.** If your project uses a different framework (React, Vue, Angular or something else), you can build directly on the GraphQL API. This approach gives you maximum flexibility but requires the most implementation work.

[Build a Custom Frontend &rarr;](/getting-started/build-a-frontend)

**Stay on the WordPress Plugin.** The plugin is a production-ready option for getting a feature-rich B2B customer portal live. With hooks, filters and template overrides you can customize the look, feel and behavior to match your requirements. If you need a working portal without building a frontend from scratch, the WordPress Plugin is a solid choice. For greater customization the Storefront SDK or a custom frontend are more viable, but the plugin on its own already covers a wide range of B2B scenarios.

[WordPress Plugin guides &rarr;](/frontend/wordpress-plugin/understanding-the-plugin)

## Connect your business systems

A B2B deployment is more than a frontend. Products, pricing, inventory, orders and customer data typically need to stay in sync between Propeller and your backend systems (ERP, PIM, CRM). The REST API handles this.

Most real projects run both workstreams in parallel: one team builds the frontend while another team builds the integrations.

[Build an Integration &rarr;](/getting-started/build-an-integration)

## Understand the GraphQL API behind the plugin

The WordPress Plugin is built on Propeller's GraphQL API. The Frontend Development Guides explain the underlying queries and mutations that power every feature you just saw, which is useful if you want to understand what happens behind the scenes or plan a custom frontend later.

[Frontend Development Guides &rarr;](/frontend)

---

## Export Orders

URL: https://docs.propeller-commerce.com/integrations/domain-guides/orders/export-orders

# Export orders

Export orders from Propeller to an external system for fulfillment. Orders are typically created in Propeller through a webshop, the Sales Hub or the API and then sent to an ERP, WMS or third-party supplier that handles logistics and delivery.

## The export flow

Exporting orders is a two-step process:

1. Search for orders that have not been exported yet
2. Update each order with export metadata after the receiving system confirms receipt

This pattern ensures every order is exported exactly once. The search filter excludes orders that already have an export status, and the update marks them as processed so they do not appear in the next export run.

## Search for unexported orders

Use the orders search endpoint with the `expands` parameter to include order items and addresses in the response. See [Expanding resources](/integrations/integration-patterns/expanding-resources) for more on the `expands` parameter.

```
POST /v2/orders/search?expands=ORDER_ITEMS,ADDRESSES
```

Filter by `status` and `exportStatuses` in the request body. An empty `exportStatuses` array matches orders where no export status has been set.

```json
{
    "status": ["NEW"],
    "exportStatuses": []
}
```

This returns all orders in status `NEW` that have not been exported yet.

### Response

```json
{
    "items": [
        {
            "shopId": 0,
            "id": 36,
            "channelId": 1,
            "uuid": "019cb83f-0e75-746c-a834-a5b567d834b7",
            "status": "NEW",
            "type": "dropshipment",
            "email": "noreply@propel.us",
            "currency": "EUR",
            "currencyRatio": 1,
            "language": "NL",
            "date": "2026-03-04T09:47:46.207Z",
            "createdAt": "2026-03-04T09:47:46.207Z",
            "postageData": {
                "method": "",
                "taxPercentage": 21,
                "requestDate": null,
                "gross": 10,
                "net": 12.1,
                "tax": 2.1,
                "partialDeliveryAllowed": "Y",
                "pickUpLocationId": null,
                "overruled": "Y",
                "carrier": null
            },
            "paymentData": {
                "net": 0,
                "gross": 0,
                "tax": 0,
                "taxPercentage": 21,
                "method": "",
                "status": "UNKNOWN",
                "statusDate": null,
                "overruled": "N",
                "accountingId": null
            },
            "total": {
                "orderId": 36,
                "gross": 910,
                "net": 1101.1,
                "tax": 191.1,
                "discountValue": 0,
                "discountType": "N",
                "taxPercentages": [],
                "isFromRevision": false,
                "sourceRevisionNumber": 3
            },
            "items": [
                {
                    "uuid": "019cb83e-c6b4-7934-91aa-b0bff014ee2e",
                    "class": "product",
                    "productId": 799,
                    "parentOrderItemId": null,
                    "sku": "12345",
                    "quantity": 6,
                    "minimumQuantity": 1,
                    "notes": "",
                    "name": "skuname",
                    "supplier": "",
                    "supplierCode": "",
                    "manufacturer": "",
                    "manufacturerCode": "",
                    "eanCode": null,
                    "unit": 1,
                    "package": "",
                    "packageUnit": "",
                    "packageUnitQuantity": "1",
                    "purchaseUnit": 1,
                    "purchaseMinimumQuantity": 1,
                    "originalPrice": 150,
                    "customerPrice": 150,
                    "price": 150,
                    "priceTotal": 900,
                    "priceNet": 181.5,
                    "costPrice": 0,
                    "priceTotalNet": 1089,
                    "discount": 0,
                    "tax": 189,
                    "taxCode": "H",
                    "taxPercentage": 21,
                    "isBonus": "N",
                    "requestDate": null,
                    "priority": 1,
                    "id": 27594,
                    "orderId": 36
                }
            ],
            "lastModifiedAt": "2026-03-04T09:48:04.707Z",
            "public": true,
            "revisionNumber": 3,
            "invalid": false,
            "sources": [],
            "userId": 14590,
            "accountManagerId": null,
            "cartId": null,
            "externalId": null,
            "debtorId": null,
            "source": "Sales Portal",
            "emailDate": null,
            "remarks": null,
            "reference": null,
            "extra3": null,
            "extra4": null,
            "statusDate": "2026-03-04T09:48:02.480Z",
            "addresses": [
                {
                    "createdAt": "2026-03-04T09:47:46.224Z",
                    "lastModifiedAt": "2026-03-04T09:47:46.224Z",
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "gender": "M",
                    "company": "Propeller test bedrijf",
                    "street": "Teststraat ",
                    "number": "12",
                    "numberExtension": null,
                    "postalCode": "1234ED",
                    "city": "Ede",
                    "region": null,
                    "country": "NL",
                    "phone": null,
                    "mobile": null,
                    "email": null,
                    "code": null,
                    "notes": null,
                    "icp": "N",
                    "type": "delivery",
                    "url": null,
                    "name": null,
                    "id": 22091,
                    "orderId": 36
                },
                {
                    "createdAt": "2026-03-04T09:47:46.224Z",
                    "lastModifiedAt": "2026-03-04T09:47:46.224Z",
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "gender": "U",
                    "company": "Propeller test bedrijf",
                    "street": "Teststraat",
                    "number": "12",
                    "numberExtension": null,
                    "postalCode": "1234ED",
                    "city": "Ede",
                    "region": null,
                    "country": "NL",
                    "phone": null,
                    "mobile": null,
                    "email": null,
                    "code": null,
                    "notes": null,
                    "icp": "N",
                    "type": "invoice",
                    "url": null,
                    "name": null,
                    "id": 22092,
                    "orderId": 36
                }
            ],
            "invoiceUserId": 14590,
            "validUntil": null,
            "companyId": 167,
            "originalOrderId": 0,
            "exportedAt": null,
            "exportStatus": "",
            "exportMessage": null,
            "publicVersionNumber": null,
            "invalidationReason": null
        }
    ],
    "itemsFound": 2,
    "offset": 12,
    "page": 1,
    "pages": 1,
    "start": 1,
    "end": 2
}
```

The key fields for mapping to an external system are:

- `items[]` contains line items with SKU, quantity and pricing
- `addresses[]` contains delivery and invoice addresses, identified by the `type` field
- `exportStatus` and `exportedAt` are empty on orders that have not been exported yet

The response includes pagination metadata (`itemsFound`, `page`, `pages`). When exporting large numbers of orders, iterate through all pages. See [Pagination](/integrations/integration-patterns/pagination) for details.

## Update the order after export

After the receiving system confirms it has processed the order, update the order in Propeller with export metadata. This prevents the order from appearing in the next export run because the `exportStatuses: []` filter no longer matches.

```
PATCH /v2/orders/id/36
```

```json
{
    "exportedAt": "2026-03-04T10:12:19.000Z",
    "exportMessage": "ERP order id = 12355",
    "exportStatus": "exported"
}
```

The three export fields:

- `exportedAt`: timestamp of when the export happened
- `exportMessage`: free text field to store a reference from the receiving system (for example the order ID in the ERP)
- `exportStatus`: status string used by the `exportStatuses` filter in the search endpoint

The `exportStatus` field accepts the following values: `exported`, `finished` or `failed`. The search filter in the orders search endpoint matches on exact values.

## Supplier and purchase order scenarios

When the export target is a third-party supplier handling fulfillment (a purchase order), it can also make sense to change the order status (for example `PURCHASED`).

```
PATCH /v2/orders/id/36
```

```json
{
    "status": "PURCHASED"
}
```

## See also

- [Expanding resources](/integrations/integration-patterns/expanding-resources) for including related data in responses
- [Pagination](/integrations/integration-patterns/pagination) for iterating through large result sets
- [Authentication and security](/integrations/integration-patterns/authentication-and-security) for token management
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Order Shipments

URL: https://docs.propeller-commerce.com/integrations/domain-guides/orders/import-order-shipments

# Import Order Shipments

Shipments add useful information for end customers and sales reps about deliveries and track and trace. With shipment data, it is also possible to see which items are yet in backorder.

## When to create shipments

While updating an order status already gives insight into the state of an order, shipments provide more detailed delivery information. Shipments are typically created when an external fulfillment system has shipping details to report back to Propeller.

## Create a shipment

```
POST /v2/orders/shipments
```

```json
{
    "orderId": 36,
    "status": "CREATED",
    "items": [
        {
            "orderItemId": 27594,
            "quantity": 4,
            "sku": "Y2200"
        }
    ],
    "trackAndTraces": [
        {
            "code": "trk123.nl",
            "carrierId": 102
        }
    ]
}
```

The request includes:

- `orderId`: the order this shipment belongs to
- `status`: the shipment status. Possible values are `CREATED`, `PROCESSING`, `IN_TRANSIT`, `OUT_FOR_DELIVERY`, `DELIVERED`, `CANCELED`, `PARTIALLY_DELIVERED`, `FAILED_DELIVERY` and `EXCEPTION`
- `items`: references order items by `orderItemId` with the quantity being shipped. Items can only reference items that exist on the order. It is not possible to add shipment info for more or different items than there are on the order.
- `trackAndTraces`: track and trace codes with a carrier reference

## Updating shipment status

```
PATCH /v2/orders/shipments/{id}
```

It can make sense to update the shipment status along the way (for example `OUT_FOR_DELIVERY`, `DELIVERED`). You can also make sure the track and trace link is accurate so that opening it always provides the correct and up to date tracking status.

## See also

- [Export orders](/integrations/domain-guides/orders/export-orders) for the full export flow
- [Update order status](/integrations/domain-guides/orders/update-order-status-of-orders) for updating order fields and status
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Orders

URL: https://docs.propeller-commerce.com/integrations/domain-guides/orders/import-orders

# Import orders

Create orders in Propeller via the REST API. This is used when orders originate outside your webshop and need to be synced into the platform.

## When to import orders

The two most common scenarios:

- **Offline orders.** In B2B, orders are created through meetings, phone calls, email or directly in the ERP. Although the Sales Hub offers options to convert these into orders, some organizations prefer to create orders in the ERP first and sync them to Propeller so sales reps and end customers can see all orders in one place.
- **Marketplace orders.** Orders created through B2C marketplaces need to be synced into Propeller to centralize order management.

## Create an order

```
POST /v2/orders
```

The request body contains the order header, line items, payment and shipping data and addresses.

```json
{
    "userId": 14590,
    "email": "customer@example.com",
    "currency": "EUR",
    "language": "NL",
    "type": "dropshipment",
    "status": "NEW",
    "items": [
        {
            "class": "product",
            "productId": 408,
            "quantity": 2,
            "sku": "#117",
            "name": "voorbeeld artikel",
            "originalPrice": 49.99,
            "price": 49.99,
            "priceTotal": 99.98,
            "taxPercentage": 21,
            "taxCode": "H",
            "isBonus": "N"
        }
    ],
    "paymentData": {
        "net": 99.99,
        "gross": 121.99,
        "tax": 22,
        "taxPercentage": 21,
        "method": "rekening",
        "status": "unknown",
        "overruled": "N"
    },
    "postageData": {
        "method": "DELIVERY",
        "taxPercentage": 21,
        "gross": 7.25,
        "net": 5.99,
        "tax": 1.26,
        "carrier": "",
        "partialDeliveryAllowed": "N",
        "overruled": "N"
    },
    "total": {
        "gross": 129.24,
        "net": 105.98,
        "tax": 23.26,
        "discountType": "A",
        "discountValue": 0
    },
    "addresses": [
        {
            "type": "invoice",
            "firstName": "John",
            "lastName": "Doe",
            "street": "123 Business Street",
            "city": "Amsterdam",
            "postalCode": "1012AB",
            "country": "NL",
            "gender": "U",
            "icp": "N"
        },
        {
            "type": "delivery",
            "firstName": "John",
            "lastName": "Doe",
            "street": "456 Home Avenue",
            "city": "Rotterdam",
            "postalCode": "3011CD",
            "country": "NL",
            "gender": "U",
            "icp": "N"
        }
    ]
}
```

The request includes:

- `userId` links the order to a user in Propeller
- `items[]` contains the line items with product reference, quantity and pricing
- `paymentData` and `postageData` contain payment and shipping totals
- `addresses[]` requires at least an `invoice` and `delivery` address, identified by the `type` field
- `total` contains the order totals including tax and discount

## Preventing export loops


Imported orders that are not marked correctly will be picked up by the order export process and sent back to the originating system, creating an infinite loop.


When you import orders from an external system (for example an ERP), those orders should not be exported back to the same system. There are two ways to prevent this:

**Option A: Set a distinctive order status.** Use a status that your export process does not pick up. If your export filters on `status: ["NEW"]`, use a different status for imported orders so they are excluded from the export search. A distinctive status also makes it easier on the frontend to distinguish these orders when displaying them to end customers.

**Option B: Mark the order as exported on creation.** Include the export fields directly in the create request so the order is immediately marked as exported:

```json
{
    "userId": 14590,
    "status": "NEW",
    "exportedAt": "2026-03-04T10:00:00.000Z",
    "exportStatus": "exported",
    "exportMessage": "Imported from ERP, skip export",
    "items": [...]
}
```

The `exportStatus` field accepts the following values: `exported`, `finished` or `failed`. By setting it on creation, the order will not match an `exportStatuses: []` filter in the [export process](/integrations/domain-guides/orders/export-orders).

## See also

- [Export orders](/integrations/domain-guides/orders/export-orders) for exporting orders to external systems
- [Authentication and security](/integrations/integration-patterns/authentication-and-security) for token management
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Update Order Status of Orders

URL: https://docs.propeller-commerce.com/integrations/domain-guides/orders/update-order-status-of-orders

# Update order status

Update orders in Propeller to keep Backoffice users, sales reps and end customers in sync with what is happening in external systems. This is typically used after an order has been exported to an ERP or WMS and the logistics process is underway.

## When to update order status

After an order is [exported](/integrations/domain-guides/orders/export-orders) to a third-party system for fulfillment, that system manages the logistics. As the order progresses (picking, packing, shipping, delivery), you want those status changes reflected in Propeller so everyone sees the current state of the order.

For adding shipment details and track and trace links, see [Import order shipments](/integrations/domain-guides/orders/import-order-shipments).

## Update an order

Use the PATCH endpoint to update one or more fields on an existing order. Only the fields included in the request body are changed. Existing values are preserved for fields that are not included.

```
PATCH /v2/orders/id/35
```

```json
{
    "status": "PLANNING"
}
```

Order statuses are configured per tenant in the Backoffice. Use the status values that match your environment's configuration.

## Updating other fields

The same endpoint can update other order fields in the same call. Common fields to update from an external system:

```json
{
    "status": "PROCESSING",
    "reference": "ERP-REF-2026-0042",
    "remarks": "Priority shipment requested by customer"
}
```

- `reference`: a reference number visible to the customer (for example a PO number or ERP reference)
- `remarks`: internal notes on the order

For updating export metadata (`exportStatus`, `exportMessage`, `exportedAt`), see [Export orders](/integrations/domain-guides/orders/export-orders).

## See also

- [Export orders](/integrations/domain-guides/orders/export-orders) for the full export flow including export metadata
- [Import order shipments](/integrations/domain-guides/orders/import-order-shipments) for adding shipment details and track and trace links
- [Authentication and security](/integrations/integration-patterns/authentication-and-security) for token management
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Categories

URL: https://docs.propeller-commerce.com/integrations/domain-guides/products-and-categories/import-categories

# Import Categories

If you have an external system like an ERP or PIM that contains a category structure in which you want to organize and display your product catalog, you can import this category structure into Propeller. In this scenario the external system is the single source of truth for the category structure. In this use case you typically use the bulk category REST endpoints by source ID.

## Endpoint

```
POST /v2/categories/bulk/sourceId
```

## Request body

```json
{
  "categories": [
    {
      "sourceId": "011000",
      "source": "REST-API",
      "names": [
        { "language": "NL", "value": "Fiets" },
        { "language": "EN", "value": "Bike" }
      ],
      "descriptions": [
        { "language": "NL", "value": "Fiets" },
        { "language": "EN", "value": "Bike" }
      ],
      "shortDescriptions": [
        { "language": "NL", "value": "Fiets" },
        { "language": "EN", "value": "Bike" }
      ],
      "parent": {
        "sourceId": "136045"
      }
    },
    {
      "sourceId": "020000",
      "source": "REST-API",
      "names": [
        { "language": "NL", "value": "Accessoires" },
        { "language": "EN", "value": "Accessories" }
      ],
      "descriptions": [
        { "language": "NL", "value": "Accessoires" },
        { "language": "EN", "value": "Accessories" }
      ],
      "shortDescriptions": [
        { "language": "NL", "value": "Accessoires" },
        { "language": "EN", "value": "Accessories" }
      ],
      "parent": {
        "sourceId": "136045"
      }
    },
    {
      "sourceId": "020100",
      "source": "REST-API",
      "names": [
        { "language": "NL", "value": "GPS" },
        { "language": "EN", "value": "GPS" }
      ],
      "descriptions": [
        { "language": "NL", "value": "GPS" },
        { "language": "EN", "value": "GPS" }
      ],
      "shortDescriptions": [
        { "language": "NL", "value": "GPS" },
        { "language": "EN", "value": "GPS" }
      ],
      "parent": {
        "sourceId": "136045"
      }
    }
  ],
  "directives": [
    {
      "fields": ["names", "descriptions"],
      "operation": "skipIfNotEmpty"
    },
    {
      "fields": [],
      "operation": "skipMoveOnUpdate"
    }
  ]
}
```

The request includes:

- `categories[]` contains the categories to create or update
- `source` and `sourceId` identify each category in the external system
- `parent.sourceId` references the parent category to build the tree structure
- `names`, `descriptions` and `shortDescriptions` accept multiple languages
- `directives[]` controls how updates are handled (see [Directives](#directives) below)

## Source identification

The `source` field should clearly refer to the origin of the category data, for example "MyERP" or "MyPIM". The `sourceId` is the unique identifier of that category in the source system. This combination allows you to update the category information or structure later using the same endpoint. The bulk category REST endpoint uses upsert operations and will either create new categories or update existing ones. See [Sources](/integrations/integration-patterns/sources) for more on how source combinations work.

## Building the tree

You build the tree structure by filling the `parent.sourceId` field on each category with the sourceId of its parent category. Each category gets one parent. Because parents are referenced by sourceId, you can import an entire tree in a single call without needing Propeller internal IDs.

## Category fields

You can fill `names`, `descriptions` and `shortDescriptions` in multiple languages. The `hidden` field controls whether the category is visible on your frontends. Set it to `"Y"` for internal or temporary categories that should not be displayed.

## Category attributes

You can send category attributes in the same payload using an `attributeDescriptionId` and a value. The value format depends on the type of attribute you are filling. See the [REST API Reference](/reference/rest) for the attributes schema.

## Directives

Directives are optional but can be useful when the external system and Propeller each own different parts of the category data.

**`skipIfNotEmpty`**: use this when you want the category structure to come from the external system but you want to enrich specific fields in Propeller. Specify the fields you want to protect (for example `names` and `descriptions`). On future updates, those fields will not be overwritten if they already have content in Propeller. This way you can manage your structure externally and enrich category names and descriptions in Propeller without the risk of them getting overwritten.

**`skipMoveOnUpdate`**: use this when you want category names and field data to come from the external system but you want the freedom to organize the category structure in Propeller. Updates from the source will keep updating fields like names and descriptions, but the tree structure you have created in Propeller will remain unchanged.

See [Directives](/integrations/integration-patterns/directives) for the full list of available directives.

## Response

The response wraps a per-record result array in `data`, with an overall `total`, `messages` and `errors`:

```json
{
  "data": [
    {
      "action": "update",
      "lookupKey": "sourceId",
      "key": "020000",
      "id": 1736,
      "categoryId": 1736,
      "uuid": "019e9214-3e84-71c7-810b-edce0feedf7e",
      "success": true,
      "statusCode": 200
    }
  ],
  "total": 1,
  "messages": ["Successfully processed 1 categories"],
  "errors": null
}
```

- `data[]` holds one result per record in the request
- `action` is `create` or `update` depending on whether the record already existed
- `lookupKey` confirms the identifier type used and `key` is the matching lookup value (the `sourceId` here)
- `id` and `categoryId` are the Propeller internal category ID
- `success` and `statusCode` report the per-record outcome
- `total` is the number of records processed; `errors` lists any failures, or is `null` when none occurred

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations work in bulk operations
- [Directives](/integrations/integration-patterns/directives) for all available directive types
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Media

URL: https://docs.propeller-commerce.com/integrations/domain-guides/products-and-categories/import-media

# Import Media

If you have an external source for your media files like images, you can use the bulk media images endpoint to import images for your products in bulk.

## Endpoint

```
POST /v2/media/images/bulk
```

## Request body

```json
[
  {
    "productId": 14733,
    "source": "MyPIM",
    "sourceId": "NCABD70005_1",
    "alt": [
      {
        "language": "en",
        "value": "Image NCABD70005"
      }
    ],
    "description": [
      {
        "language": "en",
        "value": "Image of NCABD70005"
      }
    ],
    "tags": [
      {
        "language": "en",
        "values": [
          "Product,front"
        ]
      }
    ],
    "priority": 1,
    "uploadImages": [
      {
        "language": "en",
        "uploadType": "URL",
        "urlFile": {
          "url": "http://myexamplePIM/images/productimages/NCABD70005_1",
          "fileName": "NCABD70005_1"
        }
      }
    ]
  }
]
```

## Data fields

**`productId`**: the Propeller product ID of the product you want to add the image(s) to.

**`source` and `sourceId`**: `source` specifies the origin of the image (for example "MyPIM" or "IMAGE_FTP"). `sourceId` is the unique identifier of the image in that source system, often the product number followed by `_1`, `_2`, `_3` etc. See [Sources](/integrations/integration-patterns/sources) for how source combinations work.

**`alt`, `description` and `tags`**: localized metadata for the image. These fields accept multiple languages using the standard [Localized Strings](/integrations/integration-patterns/localized-strings) format.

**`priority`**: determines the order in which images are shown. A lower number means a higher priority. An image with priority `1` will be shown before an image with priority `5`.

**`uploadImages`**: specifies the image URLs per language. Each entry contains:

- `language` — the language code
- `uploadType` — always `URL`
- `urlFile` — an object with:
  - `url` — the full URL to the image file
  - `fileName` — the file name for the image

## Response

Each image in the batch returns a result:

```json
{
  "data": [
    {
      "id": "0826c75d-2e2e-422d-b064-1c2296d5c8e7",
      "key": "NCABD70005_1",
      "lookupKey": "sourceId",
      "action": "update",
      "success": true
    }
  ],
  "messages": ["Completed"],
  "total": 1
}
```

- `success` indicates whether the operation succeeded
- `key` is the sourceId of the image
- `id` is the Propeller internal media ID (UUID)
- `action` is `create` or `update` depending on whether the image already existed
- `lookupKey` confirms the identifier type used

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations work in bulk operations
- [Localized Strings](/integrations/integration-patterns/localized-strings) for the multi-language field format
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Products

URL: https://docs.propeller-commerce.com/integrations/domain-guides/products-and-categories/import-products

# Import Products

Typically the base information of your products comes from an external source, often your ERP or your PIM. These systems contain the master data for your base product information, while enrichments are often done in Propeller. If you want to keep products in Propeller updated and create new products in bulk from an external source, the bulk REST endpoints are the endpoints to use. These endpoints use upsert operations to either create new records or update existing ones, depending on whether they already exist in Propeller.

A typical product import consists of three steps: importing the products themselves, then their prices and finally their cost prices.

## Import order

Products must be imported before prices and cost prices. Both pricing endpoints reference products by source, so the product must already exist in Propeller when the price is sent. Import your data in this order:

1. Products (with attributes)
2. Prices
3. Cost prices

## Endpoints

```
POST /v2/products/bulk/sourceId
POST /v2/prices/bulk
POST /v2/cost-prices/bulk
```

You can also use `POST /v2/products/bulk/id` for products, but this requires the external system to know the Propeller ID, and it is update-only: it cannot create new products. The source ID variant upserts (creates or updates) and is often the preferred choice.

## Import products

```json
{
  "products": [
    {
      "descriptions": [
        {
          "language": "NL",
          "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
        },
        {
          "language": "EN",
          "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
        }
      ],
      "eanCode": "0753759256289",
      "minimumQuantity": 1,
      "names": [
        {
          "language": "NL",
          "value": "Edge 1030 FietsComputer"
        },
        {
          "language": "EN",
          "value": "Edge 1030 Bike computer"
        }
      ],
      "notes": [
        {
          "language": "NL",
          "value": "Edge 1030 FietsComputer"
        },
        {
          "language": "EN",
          "value": "Edge 1030 Bike computer"
        }
      ],
      "manufacturerCode": "NCABD70004",
      "package": "STK",
      "packageDescriptions": [
        {
          "language": "NL",
          "value": "Stuks"
        },
        {
          "language": "EN",
          "value": "Pieces"
        }
      ],
      "parent": {
        "source": "REST-API",
        "sourceId": "020100"
      },
      "shortDescriptions": [
        {
          "language": "NL",
          "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
        },
        {
          "language": "EN",
          "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
        }
      ],
      "shortNames": [
        { "language": "NL", "value": "Edge 1030 FietsComputer" },
        { "language": "EN", "value": "Edge 1030 Bike computer" }
      ],
      "sku": "NCABD70004",
      "source": "TECHDATA",
      "sourceId": "NCABD70004",
      "status": "A",
      "supplier": "TECHDATA",
      "supplierCode": "NCABD70004",
      "unit": 1
    },
    {
      "descriptions": [
        {
          "language": "NL",
          "value": "De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
        },
        {
          "language": "EN",
          "value": "The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
        }
      ],
      "eanCode": "0753759256211",
      "minimumQuantity": 1,
      "names": [
        {
          "language": "NL",
          "value": "Edge 1050 FietsComputer"
        },
        {
          "language": "EN",
          "value": "Edge 1050 Bike computer"
        }
      ],
      "notes": [
        {
          "language": "NL",
          "value": "Edge 1050 FietsComputer"
        },
        {
          "language": "EN",
          "value": "Edge 1050 Bike computer"
        }
      ],
      "manufacturerCode": "NCABD70005",
      "package": "STK",
      "packageDescriptions": [
        {
          "language": "NL",
          "value": "Stuks"
        },
        {
          "language": "EN",
          "value": "Pieces"
        }
      ],
      "parent": {
        "source": "REST-API",
        "sourceId": "020100"
      },
      "shortDescriptions": [
        {
          "language": "NL",
          "value": "De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
        },
        {
          "language": "EN",
          "value": "The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
        }
      ],
      "shortNames": [
        { "language": "NL", "value": "Edge 1050 FietsComputer" },
        { "language": "EN", "value": "Edge 1050 Bike computer" }
      ],
      "sku": "NCABD70005",
      "source": "TECHDATA",
      "sourceId": "NCABD70005",
      "status": "A",
      "supplier": "TECHDATA",
      "supplierCode": "NCABD70005",
      "unit": 1
    }
  ],
  "directives": [
    {
      "fields": [
        "names",
        "descriptions"
      ],
      "operation": "skipIfNotEmpty"
    }
  ]
}
```

The request includes:

- `products[]` contains the products to create or update
- `source` and `sourceId` identify each product in the external system
- `parent` references the category to place the product in, using the `source` and `sourceId` of that category
- `names`, `descriptions` and `shortDescriptions` accept multiple languages
- `directives[]` controls how updates are handled (see [Directives](#directives) below)

### Source identification

The `source` field should clearly refer to the origin of the product data, for example "MyERP" or "MyPIM". The `sourceId` is the unique identifier of that product in the source system, usually a product number, SKU or product ID from the ERP or PIM. This combination allows you to update the product information later using the same endpoint. See [Sources](/integrations/integration-patterns/sources) for more on how source combinations work.

### Product fields

You can find a description of all available fields in the [REST API Reference](/reference/rest). There are a few fields that are good to highlight.

**`parent`**: here you can specify the `source` and `sourceId` of the category that you want the product to end up in. This is particularly useful if the source system is also leading in creating the category or catalog structure of the products. If this information is not available in the source system then you typically map all products to one specific parent folder where you import all your new products and combine that with the `skipMoveOnUpdate` directive (see [Directives](#directives) below).

**`status`**: there are multiple statuses available in Propeller. Typically the status `A` (for available) is used for all products that need to be shown and sold on the various frontends or channels. If you use any of the other statuses like `N` (for not available), `S` (for presales) or `P` (for phase out) then realise that unless you specifically request these product statuses in your GraphQL product queries it will only return the ones with status `A`. It is always important to make a good mapping of the product statuses that you use in your ERP or PIM and the statuses in Propeller, in combination with the behavior you expect from your frontends with regards to these products and statuses. Do this early in your implementation project to prevent surprises later on.

**Localized fields**: `names`, `shortNames`, `descriptions` and `shortDescriptions` can all be imported as localized strings, so you can import this data in multiple languages if the source system contains this information. See [Localized Strings](/integrations/integration-patterns/localized-strings) for the multi-language field format.

### Attributes

Your products will typically have multiple product attributes. In the bulk products by source ID endpoint you can include the attributes in the same payload. Make sure the attribute descriptions already exist in Propeller, then you can safely send all product attribute values with the product payload, regardless of the attribute type (text, enum, integer, etc.).

To include attributes, add an `attributes` array to each product. Each entry specifies the `attributeDescriptionName` (the name of the attribute as defined in Propeller) and a `value` object with the appropriate format for the attribute type:

```json
{
  "products": [
    {
      "source": "TECHDATA",
      "sourceId": "NCABD70004",
      "names": [
        { "language": "NL", "value": "Edge 1030 FietsComputer" }
      ],
      "attributes": [
        {
          "attributeDescriptionName": "WEIGHT_GRAMS",
          "value": {
            "intValue": 123
          }
        },
        {
          "attributeDescriptionName": "WATERPROOF_RATING",
          "value": {
            "textValues": [
              { "language": "NL", "values": ["IPX7"] }
            ]
          }
        }
      ]
    }
  ]
}
```

The `value` object format depends on the attribute type:

- **Text**: `{ "textValues": [{ "language": "NL", "values": ["your value"] }] }`
- **Enum**: `{ "enumValues": ["OPTION_A"] }`
- **Integer**: `{ "intValue": 42 }`
- **Decimal**: `{ "decimalValue": 9.99 }`

For more information on product attributes see the [REST API Reference](/reference/rest).

### Directives

Directives are optional but can be useful when the external system and Propeller each own different parts of the product data.

**`skipIfNotEmpty`**: in a lot of cases the ERP contains the master data of your products. Product numbers, IDs, maybe names, supplier codes and price groups should come from the ERP. But enriching the product data with nice titles often happens in Propeller or comes from an external PIM. In those cases the `skipIfNotEmpty` directive can be very useful. You import the names or descriptions of the products from the ERP, but your content team might want to enhance or beautify those in Propeller before publishing on the websites. You send the `skipIfNotEmpty` directive and in the `fields` section you specify the fields that you do not want to have overwritten on updates. This way you can keep your ERP as the master of your core product data, but specify those specific fields that it may not overwrite on updates so you can manage those in Propeller or update via an integration with yet another external source like a PIM.

**`skipMoveOnUpdate`**: if your ERP is maintaining the master product data but you want to create your commercial catalog structure in Propeller and not maintain this in your ERP then this directive comes in handy. You can import all products in one parent folder but use the `skipMoveOnUpdate` directive. In that case you are free to move products under different categories in Propeller after they have been imported and create a solid catalog structure. The directive will prevent product updates from your ERP from moving them back to the import folder where newly created products will be placed by the import. This way you are completely free to choose where you manage your product and catalog structure: in Propeller, in your ERP or in your external PIM.

See [Directives](/integrations/integration-patterns/directives) for the full list of available directives.

## Import prices

Once products exist in Propeller you can import their prices. The prices bulk endpoint creates or updates price records for products.

```
POST /v2/prices/bulk
```

```json
{
  "prices": [
    {
      "productSource": {
        "id": "NCABD70004",
        "name": "TECHDATA"
      },
      "per": 1,
      "list": 599.99,
      "store": 549.99,
      "suggested": 599.99,
      "defaultTaxCode": "H",
      "display": "DEFAULT"
    },
    {
      "productSource": {
        "id": "NCABD70005",
        "name": "TECHDATA"
      },
      "per": 1,
      "list": 749.99,
      "store": 699.99,
      "suggested": 749.99,
      "defaultTaxCode": "H",
      "display": "DEFAULT"
    }
  ]
}
```

- `productSource` references the product using the same `name` (source) and `id` (sourceId) used when importing the product
- `list` is the base selling price used for pricing calculations
- `store` is the selling price displayed in the store or webshop
- `suggested` is the manufacturer's recommended retail price
- `per` is the unit quantity the price applies to, defaults to 1
- `defaultTaxCode` is the tax classification: `H` (high rate), `L` (low rate) or `N` (no tax)
- `display` controls how the price is presented on frontends, use `DEFAULT` for standard display

## Import cost prices

Cost prices represent the purchase or procurement price of a product. The cost prices bulk endpoint creates or updates cost price records for products.

```
POST /v2/cost-prices/bulk
```

```json
{
  "bulkCostPrices": [
    {
      "source": {
        "id": "NCABD70004",
        "name": "TECHDATA"
      },
      "value": 425.00,
      "quantityFrom": 1
    },
    {
      "source": {
        "id": "NCABD70005",
        "name": "TECHDATA"
      },
      "value": 530.00,
      "quantityFrom": 1
    }
  ]
}
```

- `source` references the product using `name` (source) and `id` (sourceId). Note that this field is called `source`, not `productSource` as in the prices endpoint
- `value` is the cost or purchase price per unit
- `quantityFrom` is the minimum quantity for this cost price to apply. Use `1` for standard cost prices. Higher values allow you to create tiered cost pricing for different quantity ranges

## Batch size

You are using a bulk endpoint meaning you can send payloads with multiple products. We advise a batch size of roughly 100 products per payload. This depends on the amount of data and attributes you send with each payload.

## Response

The response wraps a per-record result array in `data`, with an overall `total`, `messages` and `errors`:

```json
{
  "data": [
    {
      "action": "create",
      "lookupKey": "sourceId",
      "key": "NCABD70005",
      "id": 14773,
      "productId": 14773,
      "success": true,
      "statusCode": 201
    }
  ],
  "total": 1,
  "messages": ["Created 1 products"],
  "errors": null
}
```

- `data[]` holds one result per record in the request
- `action` is `create` or `update` depending on whether the record already existed
- `lookupKey` confirms the identifier type used and `key` is the matching lookup value (the `sourceId` here)
- `id` and `productId` are the Propeller internal product ID
- `success` and `statusCode` report the per-record outcome
- `total` is the number of records processed; `errors` lists any failures, or is `null` when none occurred

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations work in bulk operations
- [Directives](/integrations/integration-patterns/directives) for all available directive types
- [Localized Strings](/integrations/integration-patterns/localized-strings) for the multi-language field format
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Stock

URL: https://docs.propeller-commerce.com/integrations/domain-guides/products-and-categories/import-stock

# Import Stock

Typically the data on your stock or inventory is kept in your ERP or in your WMS. But it is also possible you want to import stock levels of one of your suppliers directly into Propeller. Regardless of the source of the inventory, you want to keep your stock information in Propeller up to date so you can either show exact stock information on your website or portal, or at least a rough indication of the available stock levels of your products.

To periodically sync stock to Propeller the bulk inventory endpoint is the most logical endpoint to use.

## Endpoint

```
POST /v2/inventory/bulk/:lookupKey/:inventoryType
```

The endpoint has two path parameters:

- `:lookupKey` — how to match inventory to products in Propeller (see [External system identification](#external-system-identification) below)
- `:inventoryType` — the type of inventory: `local` or `supplier` (see [Local vs supplier stock](#local-vs-supplier-stock) below)

**Example:** `POST /v2/inventory/bulk/sourceId/local`

## External system identification

You can match the stock to the products in Propeller in several ways. The available lookup keys are `id` (the Propeller product ID), `sourceId`, `sku` or `supplierCode`. The lookup key is set as a path parameter. See [Sources](/integrations/integration-patterns/sources) for how source combinations work.

## Local vs supplier stock

The endpoint allows for syncing two types of inventory: `local` or `supplier`. This way you can distinguish between your own local inventory and possible inventories of your suppliers. The inventory type is set as a path parameter in the call.

## Data fields

**`quantity`**: the actual stock number as an integer. You always need to send the full stock as an integer and cannot send mutations like minus 1 or plus 10. Propeller also does not update inventory numbers by itself based on online sales to prevent confusion.

**`warehouseId`**: it can be relevant to display stock levels in various physical locations. Think about warehouses in multiple countries or when you allow the end customer to pick up their orders. In those cases you can create different warehouses, which will get separate warehouse IDs. Using the warehouse IDs in your inventory import allows you to separate stock levels for multiple warehouses.

**`nextDeliveryDate`**: if you have information on when new stock will arrive in your warehouse you can import this as a date in the `nextDeliveryDate` field. This can be useful information for your customers when making their purchase decision.

## Batch size

This is a bulk endpoint so you can post lots of inventory data in one payload. We advise a batch size of roughly 1000 products per call.

## Request body

```json
{
  "inventory": [
    {
      "location": "B45",
      "nextDeliveryDate": "2029-03-01 00:00:00",
      "quantity": 75,
      "source": "TECHDATA",
      "sourceId": "NCABD70004"
    }
  ]
}
```

## Response

Each inventory item in the batch returns a result:

```json
{
  "data": [
    {
      "success": true,
      "id": 11520,
      "action": "update"
    }
  ],
  "messages": ["Completed"],
  "total": 1
}
```

- `success` indicates whether the operation succeeded
- `id` is the Propeller internal inventory ID
- `action` is `create` or `update` depending on whether the inventory record already existed

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations work in bulk operations
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Export Companies, Contacts and Customers

URL: https://docs.propeller-commerce.com/integrations/domain-guides/users/export-companies-contacts-and-customers

This page is being worked on and will be available soon.


# Export Companies, Contacts and Customers

---

## Import Addresses

URL: https://docs.propeller-commerce.com/integrations/domain-guides/users/import-addresses

# Import Addresses

Addresses in Propeller belong to companies or customers. There are two ways to import them: inline as part of a company or customer bulk payload, or through dedicated address endpoints that target a specific company or customer.

The inline approach is the most common. It lets you send addresses together with the company or customer data. This is what most ERP integrations use. The dedicated address endpoints are useful when you need to manage addresses independently, for example when addresses come from a different source than the company data.

## Approach 1: Inline addresses

The simplest way to import addresses is to include them in the company or customer bulk payload. This is described in [Import Companies, Contacts and Customers](/integrations/domain-guides/users/import-companies-contacts-and-customers).

```
POST /v2/companies/bulk/sourceId
POST /v2/customers/bulk/sourceId
```

### Address-only updates

If you only want to add or update addresses on existing companies without touching any other company fields, combine the company bulk endpoint with the `skipCreate` directive. This pattern ensures that:

- No new companies are created (only existing companies get updated)
- Only the addresses in the payload are processed

This is the recommended approach when addresses come from a separate sync or a different source than the company master data.

```json
{
  "companies": [
    {
      "source": "MY_ERP",
      "sourceId": "1032644",
      "addresses": [
        {
          "type": "delivery",
          "code": "35101",
          "street": "Industrieweg",
          "number": "8",
          "postalCode": "3542 AD",
          "city": "Utrecht",
          "country": "NL",
          "email": "magazijn@bakkerbouw.nl"
        },
        {
          "type": "delivery",
          "code": "35102",
          "street": "Havenstraat",
          "number": "22",
          "postalCode": "1013 AW",
          "city": "Amsterdam",
          "country": "NL",
          "numberExtension": "B",
          "email": "levering@bakkerbouw.nl"
        }
      ]
    },
    {
      "source": "MY_ERP",
      "sourceId": "1032645",
      "addresses": [
        {
          "type": "delivery",
          "code": "35103",
          "street": "Boslaan",
          "number": "5",
          "postalCode": "7311 HN",
          "city": "Apeldoorn",
          "country": "NL"
        }
      ]
    }
  ],
  "directives": [
    {
      "operation": "skipCreate",
      "fields": []
    }
  ]
}
```

Each company in the payload is identified by its `source` and `sourceId`. The endpoint looks up the company in Propeller and adds or updates the addresses listed. The same approach works for customers using `POST /v2/customers/bulk/sourceId`.

### Grouping addresses per company

If your source system provides addresses as a flat list rather than grouped per company, you need to group them by company before sending the payload. Each company object in the `companies` array should contain all addresses for that company. A common pattern in middleware is to group addresses by source and source ID.

## Approach 2: Dedicated address endpoints

When you want to manage addresses for a specific company or customer independently, use the dedicated bulk address endpoints:

```
POST /v2/companies/{lookupKey}/{lookupValue}/addresses/bulk
POST /v2/customers/{lookupKey}/{lookupValue}/addresses/bulk
```

These endpoints target a single company or customer and accept a list of addresses for that entity.

### Path parameters

- `lookupKey`: either `id` (Propeller internal ID) or `sourceId` (the external source ID)
- `lookupValue`: the value to look up

When using `sourceId` as the lookup key, add the `source` query parameter to specify which source system the ID belongs to:

```
POST /v2/companies/sourceId/1032644/addresses/bulk?source=MY_ERP
```

### Request body

```json
{
  "addresses": [
    {
      "type": "delivery",
      "code": "35101",
      "street": "Industrieweg",
      "number": "8",
      "postalCode": "3542 AD",
      "city": "Utrecht",
      "country": "NL",
      "email": "magazijn@bakkerbouw.nl",
      "isDefault": "Y"
    },
    {
      "type": "delivery",
      "code": "35102",
      "street": "Havenstraat",
      "number": "22",
      "numberExtension": "B",
      "postalCode": "1013 AW",
      "city": "Amsterdam",
      "country": "NL",
      "email": "levering@bakkerbouw.nl"
    }
  ]
}
```

## Address types

Every address requires a `type`. Propeller supports three address types:

- `delivery`: a shipping or delivery address
- `invoice`: a billing address

A company or customer can have multiple addresses of the same type. Use `isDefault` set to `"Y"` to mark one address as the default for its type.

## Address code

The `code` field acts as a lookup key for upsert behavior on addresses. When you send an address with a code that already exists on the company or customer, the existing address is updated. When the code is new, a new address is created. This is how you keep addresses in sync without creating duplicates.

The code can be up to 64 characters. Use whatever identifier your source system has for the address record.

## The icp field

The `icp` field is relevant for B2B scenarios where you ship orders across borders within the EU. When `icp` is set to `"Y"` on a delivery address, Propeller does not apply tax to orders shipped to that address. This implements the EU intra-community supply (ICP) rule where VAT is reverse-charged to the buyer.

## Response

The inline approach returns the standard company or customer bulk response as described in [Import Companies, Contacts and Customers](/integrations/domain-guides/users/import-companies-contacts-and-customers#response).

The dedicated address endpoints return a `200` status code on success.

## See also

- [Import Companies, Contacts and Customers](/integrations/domain-guides/users/import-companies-contacts-and-customers) for importing companies, contacts and customers with inline addresses
- [Directives](/integrations/integration-patterns/directives) for all available directive types
- [Sources](/integrations/integration-patterns/sources) for how source combinations work
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Companies, Contacts and Customers

URL: https://docs.propeller-commerce.com/integrations/domain-guides/users/import-companies-contacts-and-customers

# Import Companies, Contacts and Customers

If you have an external system like an ERP or CRM that contains your company and contact data, you can import this data into Propeller using the bulk REST endpoints. In a B2B scenario you typically import companies and their contacts. In a B2C scenario you import customers. The bulk endpoints use upsert operations to either create new records or update existing ones, so you can use the same integration for your initial import and for ongoing syncs.

## Endpoints

```
POST /v2/companies/bulk/sourceId
POST /v2/contacts/bulk/sourceId
POST /v2/customers/bulk/sourceId
```

You can also use `id` instead of `sourceId` as the lookup key, but this requires the external system to know the Propeller internal IDs. The `sourceId` variant is the recommended choice.

## Import order

Companies must be imported before contacts. A contact belongs to a company, and the link between them is established through the parent field on the contact. If the parent company does not exist yet in Propeller when the contact is imported, the response will return an error and the contact will not be created.

Customers are independent and do not have a parent. They can be imported at any time.

## Request body: companies

```json
{
  "companies": [
    {
      "source": "MY_ERP",
      "sourceId": "1032644",
      "sources": [{ "name": "MY_ERP", "id": "1032644" }],
      "language": "NL",
      "name": "Bakker Bouw B.V.",
      "debtorId": "29931",
      "taxNumber": "NL812345678B01",
      "cocNumber": "12345678",
      "email": "info@bakkerbouw.nl",
      "phone": "0301234567",
      "addresses": [
        {
          "type": "invoice",
          "code": "34766",
          "street": "Kerkstraat",
          "number": "34",
          "postalCode": "3511 AB",
          "city": "Utrecht",
          "country": "NL",
          "email": "factuur@bakkerbouw.nl",
          "isDefault": "Y"
        }
      ],
      "attributes": [
        {
          "attributeDescriptionName": "SHOW_REKENING",
          "value": {
            "enumValues": ["Y"]
          }
        }
      ]
    },
    {
      "source": "MY_ERP",
      "sourceId": "1032645",
      "sources": [{ "name": "MY_ERP", "id": "1032645" }],
      "language": "NL",
      "name": "De Vries Houthandel B.V.",
      "debtorId": "29932",
      "taxNumber": "NL876543210B01",
      "cocNumber": "87654321",
      "email": "info@devrieshout.nl",
      "phone": "0207654321"
    }
  ],
  "directives": [
    {
      "operation": "skipIfNotEmpty",
      "fields": ["name", "email"]
    }
  ]
}
```

The request includes:

- `companies[]` contains the companies to create or update
- `sources` identifies each company in the external system (see [Source identification](#source-identification) below)
- `addresses[]` can be included inline to create or update company addresses (see [Attributes and addresses](#attributes-and-addresses) below)
- `attributes[]` can be included to set attribute values on the company (see [Attributes and addresses](#attributes-and-addresses) below)
- `directives[]` controls how updates are handled (see [Directives](#directives) below)

## Request body: contacts

```json
{
  "contacts": [
    {
      "source": "MY_ERP",
      "sourceId": "69573",
      "sources": [{ "name": "MY_ERP", "id": "69573" }],
      "language": "NL",
      "parent": {
        "source": "MY_ERP",
        "sourceId": "1032644"
      },
      "firstName": "Jan",
      "middleName": "van der",
      "lastName": "Berg",
      "debtorId": "29947",
      "email": "j.vanderberg@bakkerbouw.nl",
      "phone": "0301234568",
      "mobile": "0612345678",
      "primaryLanguage": "NL",
      "gender": "M",
      "attributes": [
        {
          "attributeDescriptionName": "DEPARTMENT",
          "value": {
            "textValues": [{ "language": "NL", "values": ["Inkoop"] }]
          }
        }
      ]
    },
    {
      "source": "MY_ERP",
      "sourceId": "69574",
      "sources": [{ "name": "MY_ERP", "id": "69574" }],
      "language": "NL",
      "parent": {
        "source": "MY_ERP",
        "sourceId": "1032644"
      },
      "firstName": "Lisa",
      "lastName": "Jansen",
      "debtorId": "29948",
      "email": "l.jansen@bakkerbouw.nl",
      "phone": "0301234569",
      "primaryLanguage": "NL",
      "gender": "F"
    }
  ],
  "directives": [
    {
      "operation": "skipIfNotEmpty",
      "fields": ["firstName", "lastName", "email"]
    }
  ]
}
```

The contact payload includes:

- `parent` links the contact to a company using the company's source name and source ID (see [Linking contacts to companies](#linking-contacts-to-companies) below)
- Person fields like `firstName`, `middleName`, `lastName`, `email`, `phone`, `mobile`, `gender` and `primaryLanguage`
- `attributes[]` can be included to set attribute values on the contact (see [Attributes and addresses](#attributes-and-addresses) below)

## Request body: customers

Customers use the same person fields as contacts (`firstName`, `lastName`, `email`, etc.) but do not have a parent company. The `parent` field is deprecated on customers. Customers can include inline addresses.

```json
{
  "customers": [
    {
      "source": "MY_ERP",
      "sourceId": "1032656",
      "sources": [{ "name": "MY_ERP", "id": "1032656" }],
      "language": "NL",
      "firstName": "Pieter",
      "middleName": "",
      "lastName": "Alberts",
      "debtorId": "29935",
      "phone": "0612349876",
      "primaryLanguage": "NL",
      "addresses": [
        {
          "type": "invoice",
          "code": "34772",
          "street": "Dorpsweg",
          "number": "60",
          "postalCode": "9138 TH",
          "city": "Oosterbeek",
          "country": "NL",
          "isDefault": "Y"
        }
      ],
      "attributes": [
        {
          "attributeDescriptionName": "NEWSLETTER_OPTIN",
          "value": {
            "enumValues": ["Y"]
          }
        }
      ]
    }
  ]
}
```

## Source identification

The `sources` array identifies each record in the external system. Each source entry has a `name` (the name of the external system, for example "MY_ERP") and an `id` (the unique identifier of the record in that system). The recommendation is the source name to be uppercase with underscores and use the same one across all integrations with the same system. The source ID should be whatever unique identifier the external system uses for the record.

This combination allows the bulk endpoint to determine whether a record already exists in Propeller. If a record with that source combination exists, it gets updated. If not, a new record is created. See [Sources](/integrations/integration-patterns/sources) for more on how source combinations work.

## Linking contacts to companies

To assign a contact to a company, fill the `parent` field with the `source` and `sourceId` of the parent company. This way you do not need to know the Propeller internal company ID. As long as the company was imported with the same source name and source ID, Propeller resolves the link automatically.

```json
"parent": {
  "source": "MY_ERP",
  "sourceId": "1032644"
}
```

This is why companies must be imported before contacts. The parent company must already exist in Propeller for the link to be established.

## Fields and validation

You can find the full list of available fields in the [REST API Reference](/reference/rest). The endpoints enforce validation rules on several fields. If a record fails validation, the endpoint returns an error for that specific record and stops processing the whole batch. Validating your data before sending it to Propeller helps avoid partial failures.

Key validation rules:

- `email` must be a valid email format
- `name` (company): max 200 characters
- `firstName`: max 30 characters (contacts), max 100 characters (customers)
- `middleName`: max 20 characters
- `lastName`: max 50 characters (contacts), max 100 characters (customers)
- `phone` and `mobile`: max 30 characters
- `taxNumber`: max 50 characters
- `cocNumber`: max 50 characters

## Attributes and addresses

You can include attributes and addresses as sub-objects in the same payload.

**Attributes** can be sent with companies, contacts and customers. Each attribute requires an `attributeDescriptionName` that matches an existing attribute description in Propeller and a `value` object that matches the attribute type. Make sure the attribute descriptions already exist before sending attribute values.

**Addresses** can be included in the company and customer payloads. Each address requires a `type` (delivery or invoice), `street`, `postalCode`, `city` and `country`. Contacts do not support addresses in the bulk payload. To import addresses for companies separately, see [Import Addresses](/integrations/domain-guides/users/import-addresses).

## Directives

Directives are optional but can be useful when the external system and Propeller each own different parts of the data.

**`skipIfNotEmpty`**: use this when the external system provides the initial data but you want to enrich specific fields in Propeller. Specify the fields you want to protect (for example `name` and `email`). On future updates, those fields will not be overwritten if they already have content in Propeller.

**`skipCreate`**: use this when you only want to update existing records and never create new ones. Records that do not already exist in Propeller will be skipped.

See [Directives](/integrations/integration-patterns/directives) for the full list of available directives.

## Batch size

The bulk endpoints accept up to 1000 records per request, but we recommend sending 100 to 200 records per batch. Smaller batches are easier to debug when something goes wrong. See [Sync Strategies](/integrations/integration-patterns/sync-strategies) for more on batch sizing and scheduling.

## Response

Each record in the batch returns a result:

```json
{
  "data": [
    {
      "action": "create",
      "id": 123,
      "success": true,
      "lookupKey": "sourceId",
      "key": "1032644"
    }
  ],
  "messages": ["Bulk operation completed successfully"],
  "total": 1
}
```

- `success` indicates whether the operation succeeded
- `key` is the source ID of the record
- `id` is the Propeller internal ID
- `action` is `create`, `update` or `skip` depending on the outcome
- `lookupKey` confirms the identifier type used

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations work in bulk operations
- [Directives](/integrations/integration-patterns/directives) for all available directive types
- [Sync Strategies](/integrations/integration-patterns/sync-strategies) for scheduling and batch sizing recommendations
- [Import Addresses](/integrations/domain-guides/users/import-addresses) for importing addresses separately
- [REST API Reference](/reference/rest) for the full endpoint specification

---

## Import Customer-specific Pricing

URL: https://docs.propeller-commerce.com/integrations/domain-guides/users/import-customer-specific-pricing

This page is being worked on and will be available soon.


# Import Customer-specific Pricing

---

## Integration Guides

URL: https://docs.propeller-commerce.com/integrations

# Integration Development Guides

Guides for partners connecting Propeller with external business systems. All content in this section uses the **REST API**.

Each topic starts with a concept explanation covering how Propeller handles the domain from an integration perspective, followed by practical how-to content with code examples.

## Integration patterns

Architectural patterns, core API concepts and authentication. Start here to understand how Propeller fits into a business system landscape.

- [Sources](/integrations/integration-patterns/sources) — connecting external system identifiers to Propeller resources
- [Lookup Keys](/integrations/integration-patterns/lookup-keys) — referencing resources by external ID instead of internal Propeller IDs
- [Pagination](/integrations/integration-patterns/pagination) — controlling list results with page and offset parameters
- [Directives](/integrations/integration-patterns/directives) — controlling bulk endpoint behavior during data import
- [Expanding Resources](/integrations/integration-patterns/expanding-resources) — requesting related data inline to avoid separate API calls
- [Localized Strings](/integrations/integration-patterns/localized-strings) — handling multi-language content in API requests and responses
- [B2B/B2C Data Models](/integrations/integration-patterns/b2b-and-b2c) — differences between business and consumer commerce data models
- [Authentication and security](/integrations/integration-patterns/authentication-and-security) — OAuth 2.0 token management and credential security

## Domain guides

Domain-level guides for syncing data between Propeller and external business systems (ERP, PIM, CRM).

### Users

- [Import Companies, Contacts and Customers](/integrations/domain-guides/users/import-companies-contacts-and-customers)
- [Import Addresses](/integrations/domain-guides/users/import-addresses)
- [Export Companies, Contacts and Customers](/integrations/domain-guides/users/export-companies-contacts-and-customers)
- [Import Customer-specific Pricing](/integrations/domain-guides/users/import-customer-specific-pricing)

### Products and Categories

- [Import Categories](/integrations/domain-guides/products-and-categories/import-categories)
- [Import Products](/integrations/domain-guides/products-and-categories/import-products)
- [Import Media](/integrations/domain-guides/products-and-categories/import-media)
- [Import Stock](/integrations/domain-guides/products-and-categories/import-stock)

### Orders

- [Import Orders](/integrations/domain-guides/orders/import-orders)
- [Import Order Shipments](/integrations/domain-guides/orders/import-order-shipments)
- [Update Order Status of Orders](/integrations/domain-guides/orders/update-order-status-of-orders)
- [Export Orders](/integrations/domain-guides/orders/export-orders)

---

## Authentication and Security

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/authentication-and-security

# Authentication and security

The REST API uses OAuth 2.0 client credentials for authentication. Tokens expire after 30 minutes. If your integration runs unattended (syncing products from an ERP, exporting orders on a schedule), you need to handle token renewal automatically.

This page covers how to manage authentication in production integrations. For a first-time walkthrough of getting a token, see [Getting Started → Authenticate](/getting-started/build-an-integration/authenticate).

## Token lifecycle

Your integration follows a simple cycle:

1. Request an access token using your `client_id` and `client_secret`
2. Use that token for API requests (up to 30 minutes)
3. Request a new token when the current one expires

There are no refresh tokens. When a token expires, you request a completely new one using the same client credentials. This means your integration always needs access to the credentials, not just a stored token.

## Requesting a token

Send a POST request to the token endpoint with your credentials:

```
POST https://api.helice.cloud/oauth2/token
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&client_secret=your_client_secret&grant_type=client_credentials
```

A successful response returns the token and its lifetime:

```json
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5...",
  "expires_in": 1800,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "not-before-policy": 0,
  "scope": "profile"
}
```

| Field | Description |
|---|---|
| `access_token` | The bearer token to use in API requests |
| `expires_in` | Token lifetime in seconds (1800 = 30 minutes) |
| `token_type` | Always `Bearer` |
| `scope` | Token permissions |

## Using the token

Include the token as a Bearer token in the `Authorization` header of every API request:

```
GET https://api.helice.cloud/v2/products/sku/QSFP-40G-SR4
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5...
Content-Type: application/json
```

## Token renewal

Build a renewal buffer of about 5 minutes into your integration. Before each API call, check whether the token will expire within 5 minutes. If it will, request a new token before making the call. This prevents tokens from expiring mid-request.

For long-running sync operations that make hundreds of calls, the renewal logic should run transparently between requests without interrupting the sync.

## Handling authentication errors

Not all auth errors should be retried. Your integration needs to distinguish between temporary failures and permanent ones.

### Expired token (401)

If an API request returns `401`, the token has expired or is invalid. Request a new token and retry the call once. If the retry also fails with `401`, the problem is not token expiration.

```json
{
  "message": "JWT token invalid"
}
```

### Invalid credentials (401 `invalid_client`)

If the token request itself returns `401` with `error` value `invalid_client`, your credentials are wrong. Do not retry in a loop. Log the error, send an alert and stop the sync run. Retrying with the same credentials will never succeed and may trigger rate limiting.

```json
{
  "error": "invalid_client",
  "error_description": "Invalid client or Invalid client credentials"
}
```

### Bad request (400 `unsupported_grant_type`)

If the token request returns `400`, the request format is wrong. Verify that `Content-Type` is set to `application/x-www-form-urlencoded` and that all three parameters (`client_id`, `client_secret`, `grant_type`) are included in the request body.

```json
{
  "error": "unsupported_grant_type",
  "error_description": "Unsupported grant_type"
}
```

### Insufficient permissions (403 `insufficient_scope`)

If an API request returns `403`, the token does not have permission to access the requested resource. Check the API key in the Backoffice under **Admin > API Key Management**.

### Rate limiting (429)

If you receive `429`, back off and retry with exponential delays. Start with a 1 second delay and double it on each retry, up to a maximum of 30 seconds. Stop retrying after 5 attempts.

### Error reference

| HTTP status | Error code | Cause | Action |
|---|---|---|---|
| 400 | `unsupported_grant_type` | Malformed token request | Check Content-Type header and request body parameters |
| 401 | `invalid_client` | Wrong credentials | Verify client_id and client_secret in the Backoffice |
| 401 | `invalid_token` | Token expired | Request a new token and retry once |
| 403 | `insufficient_scope` | Missing permissions | Check the API key in the Backoffice |
| 429 | `rate_limit_exceeded` | Too many requests | Retry with exponential backoff |

## Securing credentials

Keep your `client_id` and `client_secret` out of source code:

- **Use environment variables** or a secrets manager (AWS Secrets Manager, Azure Key Vault, HashiCorp Vault). Never hardcode credentials in your integration code or configuration files that are committed to version control.
- **Use separate credentials per environment.** Create a separate API key in the Backoffice for your test and production environments. This prevents test integrations from accidentally modifying production data.
- **Rotate credentials periodically.** Create a new API key in the Backoffice, update your integration to use the new credentials, verify it works, then delete the old key.

## See also

- [Getting Started → Authenticate](/getting-started/build-an-integration/authenticate) for a first-time walkthrough
- [Get Access Token endpoint](/reference/rest/endpoints/get-access-token) for the full endpoint specification

---

## B2B and B2C Data Models

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/b2b-and-b2c

# B2B and B2C data models

Propeller supports both B2B and B2C commerce through separate data models. Which REST API resources you use depends on whether you are managing business customers, individual consumers or both.

## Key differences

| Aspect | B2B | B2C |
|---|---|---|
| Primary users | Companies and their employees | Individual consumers |
| Data structure | Hierarchical (companies → contacts) | Flat (individual customers) |
| Pricing model | Negotiated, customer-specific | Standard or customer-specific |
| User management | Role-based access control | Individual accounts |
| Catalog access | Restricted, customer-specific | Public or customer-specific |

## B2B: companies and contacts

The B2B model is used in environments where a predefined set of customers is allowed access to a webshop or portal. The customer or debtor is a company with a unique `debtorId`. The contacts are persons within the organization, each with their own email address, telephone number and multiple different invoice, delivery and visiting addresses.

```
Company (organization)
├── Contact (employee/user)
├── Contact (employee/user)
└── Addresses
```

Companies contain:

- Company information (name, tax number, contact details)
- Organizational hierarchy (parent-child relationships)
- Inherited settings and permissions
- Budget and ordering restrictions
- Address management

Contacts contain:

- Personal information (name, email, phone)
- Role-based permissions
- Order history and preferences

### B2B API usage

Create a company:

```
POST /v2/companies

{
  "name": "Acme Corporation",
  "taxNumber": "NL123456789B01",
  "parent": { "sourceId": "PARENT_COMP", "source": "CRM" }
}
```

Create a contact within a company:

```
POST /v2/contacts

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@acme.com",
  "parent": { "sourceId": "ACME_CORP", "source": "CRM" }
}
```

Get company contacts:

```
GET /v2/companies/id/123?expands=contacts
```

## B2C: customers

In B2C, there is no company hierarchy. Each buyer is a **customer** with their own account.

```
Customer (individual)
├── Personal information
└── Addresses
```

Customers contain:

- Personal information (name, email, phone)
- Order history and preferences
- Multiple addresses (billing, shipping)
- Account settings and preferences

### B2C API usage

Create a customer:

```
POST /v2/customers

{
  "firstName": "Jane",
  "lastName": "Smith",
  "email": "jane.smith@email.com",
  "phone": "+1234567890"
}
```

## Resource structure

| Resource | B2B | B2C |
|---|---|---|
| Companies | Primary organizational unit | Not applicable |
| Contacts | Users within companies | Not applicable |
| Customers | Not applicable | Primary user unit |
| Orders | Company/contact-based | Customer-based |

## Integration patterns

### B2B: ERP and CRM sync

Sync company data from ERP:

```
POST /v2/companies/bulk/sourceId

{
  "companies": [
    {
      "sourceId": "ERP_COMP_001",
      "source": "SAP_ERP",
      "name": "Acme Corporation"
    }
  ]
}
```

Sync contact data from CRM:

```
POST /v2/contacts/bulk/sourceId

{
  "contacts": [
    {
      "sourceId": "CRM_CONTACT_001",
      "source": "SALESFORCE",
      "firstName": "John",
      "lastName": "Doe",
      "parent": { "sourceId": "ACME_CORP", "source": "CRM" }
    }
  ]
}
```

### B2C: e-commerce sync

Sync customer data from e-commerce platform:

```
POST /v2/customers/bulk/sourceId

{
  "customers": [
    {
      "sourceId": "SHOP_CUSTOMER_001",
      "source": "SHOPIFY",
      "firstName": "Jane",
      "lastName": "Smith"
    }
  ]
}
```

## Using both models together

Propeller supports using both B2B and B2C models in the same environment. You can use companies and contacts for your B2B operations and customers for your B2C operations simultaneously.

## See also

- [Sources](/integrations/integration-patterns/sources) for tracking external system identifiers on companies, contacts and customers
- [Lookup Keys](/integrations/integration-patterns/lookup-keys) for referencing user resources by different identifiers
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Directives

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/directives

# Directives

Directives control how bulk endpoints handle data during import. They are only available on bulk endpoints and are specified in the request payload.

## Available directives

| Directive | Fields | Effect |
|---|---|---|
| `skipIfNotEmpty` | Array of field names | On update, skip updating fields of an existing resource that are not empty |
| `skipMoveOnUpdate` | Empty array `[]` | On update, skip moving an existing resource in the parent resource provided |
| `skipCreate` | Empty array `[]` | Skip creating new resources, only update existing ones |
| `mergeTranslationsOnUpdate` | Empty array `[]` | On update, delete all translations for a resource that are not provided in the payload |

## skipIfNotEmpty

Preserve existing data by skipping updates to non-empty fields. Pass an array of field names to protect.

```json
{
  "products": [
    {
      "sourceId": "PROD-001",
      "source": "ERP_SYSTEM",
      "names": [{ "language": "EN", "value": "Updated Product Name" }],
      "descriptions": [{ "language": "EN", "value": "Updated description" }]
    }
  ],
  "directives": [
    { "fields": ["names", "descriptions"], "operation": "skipIfNotEmpty" }
  ]
}
```

If `names` or `descriptions` already have content, they will not be overwritten. Empty fields will still be updated.

## skipMoveOnUpdate

Prevent resources from being moved to a different parent. The product data gets updated but the product stays in its current category.

```json
{
  "products": [
    {
      "sourceId": "PROD-001",
      "source": "ERP_SYSTEM",
      "parent": { "sourceId": "NEW_CATEGORY", "source": "ERP_SYSTEM" },
      "names": [{ "language": "EN", "value": "Updated Product" }]
    }
  ],
  "directives": [
    { "fields": [], "operation": "skipMoveOnUpdate" }
  ]
}
```

## skipCreate

Only update existing resources. Resources in the payload that do not already exist in Propeller are skipped.

```json
{
  "products": [
    {
      "sourceId": "EXISTING_PROD",
      "source": "ERP_SYSTEM",
      "names": [{ "language": "EN", "value": "Updated Name" }]
    },
    {
      "sourceId": "NEW_PROD",
      "source": "ERP_SYSTEM",
      "names": [{ "language": "EN", "value": "New Product" }]
    }
  ],
  "directives": [
    { "fields": [], "operation": "skipCreate" }
  ]
}
```

`EXISTING_PROD` will be updated. `NEW_PROD` will be skipped.

## mergeTranslationsOnUpdate

Replace all translations with only those provided in the payload. Any language version not included gets deleted.

```json
{
  "products": [
    {
      "sourceId": "PROD-001",
      "source": "ERP_SYSTEM",
      "names": [
        { "language": "EN", "value": "English Name" },
        { "language": "NL", "value": "Dutch Name" }
      ]
    }
  ],
  "directives": [
    { "fields": [], "operation": "mergeTranslationsOnUpdate" }
  ]
}
```

Only English and Dutch translations will remain. All other language translations will be deleted.

## Combining directives

Multiple directives can be used together in a single request:

```json
{
  "products": [],
  "directives": [
    { "fields": ["names", "descriptions"], "operation": "skipIfNotEmpty" },
    { "fields": [], "operation": "skipMoveOnUpdate" },
    { "fields": [], "operation": "mergeTranslationsOnUpdate" }
  ]
}
```

## See also

- [Sources](/integrations/integration-patterns/sources) for how bulk endpoints use source combinations
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Expanding Resources

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/expanding-resources

# Expanding resources

Some resources allow you to request additional information as an expanded resource by using the `expands` request parameter. When an object contains related data, you can expand it inline rather than making separate API calls.

The `expands` parameter is available on all GET requests.

## Available expand parameters

| Parameter | Description | Applies to |
|---|---|---|
| `sources` | External system references | Products, categories, companies, customers, contacts, clusters |
| `parent` | Parent resource in hierarchical structures | Companies, customers, contacts, clusters |
| `translation` | Translated fields for all available languages | Products, categories, clusters |
| `order_items` | All items within an order | Orders |
| `order_items.product` | Product data for each order item | Orders |
| `addresses` | Shipping and billing addresses | Orders |
| `clusterConfig` | Cluster configuration settings | Clusters |
| `options` | All options within a product cluster | Clusters |
| `products` | Related products | Clusters, pricesheets |
| `defaultProduct` | Default product for a cluster or option | Clusters, options |
| `surcharges` | Additional fees and surcharges | Products |
| `inventoryBalance` | Stock levels and availability | Products |


The expand parameters listed above represent only a subset of all available expansion options. For a complete list of available expand parameters for each entity, refer to the individual entity documentation pages.


## Multiple expansions

Combine multiple expansions in a single request by separating them with commas:

```
GET /v2/products/123?expands=sources,parent,translation
```

## See also

- [Localized Strings](/integrations/integration-patterns/localized-strings) for retrieving translations with `?expands=translation`
- [Pagination](/integrations/integration-patterns/pagination) for controlling page sizes alongside expansions
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Localized Strings

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/localized-strings

# Localized strings

The Propeller REST API uses `LocalizedString` and `LocalizedStringArray` data types to handle multi-language content. These types allow you to store and retrieve content in multiple languages for entities like products, categories and surcharges.

## LocalizedString

Used for fields that contain a single translatable value across multiple languages.

```json
{
  "language": "EN",
  "value": "Product Name"
}
```

| Property | Type | Required | Description |
|---|---|---|---|
| `language` | string | Yes | 2-character language code per ISO 639-1 |
| `value` | string | Yes | The translated text content |

`LocalizedString` is typically used in arrays to represent content in multiple languages:

```json
[
  { "language": "EN", "value": "Product Name" },
  { "language": "NL", "value": "Productnaam" },
  { "language": "DE", "value": "Produktname" }
]
```

## LocalizedStringArray

Used for fields that contain multiple text values in multiple languages, such as tags or keywords.

```json
{
  "language": "EN",
  "values": ["Tag1", "Tag2", "Tag3"]
}
```

| Property | Type | Required | Description |
|---|---|---|---|
| `language` | string | Yes | 2-character language code per ISO 639-1 |
| `values` | string[] | Yes | Array of translated text values |

`LocalizedStringArray` is typically used in arrays to represent multiple values in multiple languages:

```json
[
  { "language": "EN", "values": ["Electronics", "Gadgets", "Technology"] },
  { "language": "NL", "values": ["Elektronica", "Gadgets", "Technologie"] },
  { "language": "DE", "values": ["Elektronik", "Gadgets", "Technologie"] }
]
```

## Common use cases

### Product information

Products use `LocalizedString` for names and descriptions, and `LocalizedStringArray` for keywords:

```json
{
  "names": [
    { "language": "EN", "value": "Garmin Edge 1030" },
    { "language": "NL", "value": "Garmin Edge 1030" },
    { "language": "DE", "value": "Garmin Edge 1030" }
  ],
  "descriptions": [
    { "language": "EN", "value": "High-end cycling computer with advanced features" },
    { "language": "NL", "value": "High-end fietscomputer met geavanceerde functies" },
    { "language": "DE", "value": "High-End-Fahrradcomputer mit erweiterten Funktionen" }
  ],
  "keywords": [
    { "language": "EN", "values": ["cycling", "computer", "GPS"] },
    { "language": "NL", "values": ["fietsen", "computer", "GPS"] },
    { "language": "DE", "values": ["Radfahren", "Computer", "GPS"] }
  ]
}
```

### Attributes

Attributes use `LocalizedStringArray` for text values that can have multiple entries per language:

```json
{
  "textValues": [
    { "language": "EN", "values": ["Red", "Blue", "Green"] },
    { "language": "NL", "values": ["Rood", "Blauw", "Groen"] },
    { "language": "DE", "values": ["Rot", "Blau", "Grün"] }
  ]
}
```

## Language codes

The API uses 2-character language codes as defined by [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).

| Language | Code | Language | Code |
|---|---|---|---|
| English | `EN` | Dutch | `NL` |
| German | `DE` | French | `FR` |
| Spanish | `ES` | Italian | `IT` |
| Portuguese | `PT` | Swedish | `SV` |
| Norwegian | `NO` | Danish | `DA` |
| Finnish | `FI` | Polish | `PL` |
| Czech | `CS` | Hungarian | `HU` |
| Slovak | `SK` | Slovenian | `SL` |
| Croatian | `HR` | Serbian | `SR` |
| Bulgarian | `BG` | Romanian | `RO` |
| Greek | `EL` | Turkish | `TR` |
| Russian | `RU` | Ukrainian | `UK` |
| Japanese | `JA` | Korean | `KO` |
| Chinese (Simplified) | `ZH` | Chinese (Traditional) | `ZH-TW` |
| Arabic | `AR` | Hebrew | `HE` |
| Thai | `TH` | Vietnamese | `VI` |


Language codes are always uppercase.


## Retrieving localized content

Get a product in a specific language:

```
GET /v2/products/123?language=EN
```

Get a product with all translations:

```
GET /v2/products/123?expands=translation
```

When a translation is not available, the API returns the default language or the first available translation.

## See also

- [Expanding Resources](/integrations/integration-patterns/expanding-resources) for using `?expands=translation` to retrieve all language versions
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Lookup Keys

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/lookup-keys

# Lookup keys

Lookup keys let you reference resources using various identifiers. Instead of always using the internal Propeller ID, you can look up resources by external ID, source combination, SKU or supplier code.

Lookup keys are case-sensitive. Use the exact casing shown here, for example `sourceId` (not `sourceid`).

## Available lookup keys

| Lookup key | Description | Uniqueness |
|---|---|---|
| `id` | Unique Propeller internal identifier | Always unique |
| `sourceId`/`source` | External system unique ID. `sourceId` always needs to be combined with a `source` | Unique in combination |
| `sku` | Stock-keeping unit code referencing a product | May not be unique |
| `supplierCode`/`supplier` | Code of a supplier referencing a product | May not be unique |
| `externalId` | External identifier | Always unique |

## URL patterns

For individual resource operations (GET, PATCH, DELETE), use the lookup key in the URL path:

```
GET /v2/products/id/481189

GET /v2/products/sourceId/NCABD70004

GET /v2/products/sku/PROD-001

GET /v2/products/supplierCode/ABC123
```

## Uniqueness

A `sku` is not guaranteed to be unique in the catalog, as multiple products with the same `sku` can exist. The `supplierCode`/`supplier` combination also does not have to be unique. When multiple resources match a lookup key, the API returns an error:

```json
{
  "error": {
    "code": 80005,
    "status": 400,
    "type": "ProductMultipleFound",
    "messages": ["Multiple products found. Please provide additional filters"]
  }
}
```

When no resource matches the lookup key, the API returns a 404:

```json
{
  "error": {
    "code": 80006,
    "status": 404,
    "type": "ProductNotFound",
    "messages": ["Product with id [481189] not found"]
  }
}
```

The `sourceId`/`source` combination is the most important lookup key for integrations. See [Sources](/integrations/integration-patterns/sources) for details.

## Bulk operations

Bulk endpoints require `sourceId` combined with `source` for identifying resources:

```
POST /v2/products/bulk/sourceId

{
  "products": [
    {
      "sourceId": "NCABD70004",
      "source": "TECHDATA",
      "names": [{ "language": "EN", "value": "Product Name" }]
    }
  ]
}
```

Lookup keys must be unique within a single bulk request. The `sourceId`/`source` combination must be unique across the items in one request, and `id` values must be unique within one request. Requests that contain duplicate lookup keys are rejected, and the records array cannot be empty.

The `/bulk/sourceId` variant upserts: it creates records that do not yet exist and updates the ones that do. The `/bulk/id` variant is update-only and cannot create new records, since it requires the Propeller `id` to already exist.

## Lookup keys per resource

| Resource | Supported lookup keys |
|---|---|
| Products | `id`, `sourceId`, `sku`, `supplierCode` |
| Categories | `id`, `sourceId` |
| Companies | `id`, `sourceId` |
| Customers | `id`, `sourceId` |
| Contacts | `id`, `sourceId` |
| Clusters | `id`, `sourceId`, `code` |
| Cluster Config | `id`, `name` |
| Pricesheets | `id`, `code` |
| Attributes | `id`, `name` |

## See also

- [Sources](/integrations/integration-patterns/sources) for details on source/sourceId combinations
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Pagination

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/pagination

# Pagination

Endpoints that return lists of resources are paginated. You control pagination with two parameters:

- **`page`**: which page to retrieve (starts at 1)
- **`offset`**: how many items per page (minimum 1, maximum varies per endpoint)

The default `offset` on most endpoints is `12`.

## GET endpoints

For GET requests that support pagination, pass `page` and `offset` as query parameters:

```
GET /v2/{resource}?page=1&offset=10

GET /v2/{resource}?page=2&offset=10

GET /v2/{resource}?page=3&offset=10
```

## POST search endpoints

For POST search endpoints like `/v2/orders/search`, include pagination in the request body alongside your filters:

```json
{
  "statuses": ["NEW"],
  "page": 1,
  "offset": 25
}
```

## Response metadata

Every paginated response includes metadata alongside the `data` array:

```json
{
  "data": [
    { "id": 56897, "sku": "QSFP-40G-SR4" },
    { "id": 36975, "sku": "C9600-LC-48YL" }
  ],
  "messages": [],
  "start": 1,
  "end": 2,
  "page": 1,
  "pages": 18,
  "total": 2,
  "offset": 2,
  "itemsFound": 35
}
```

| Field | Type | Description |
|---|---|---|
| `data` | array | Array of resources for the current page |
| `start` | integer | First item number on the current page |
| `end` | integer | Last item number on the current page |
| `page` | integer | Current page number |
| `pages` | integer | Total number of pages |
| `total` | integer | Number of items on the current page |
| `offset` | integer | Number of items per page |
| `itemsFound` | integer | Total number of items across all pages |

To iterate through all results, loop from `page` 1 to `pages`, incrementing by 1.

## See also

- [Expanding Resources](/integrations/integration-patterns/expanding-resources) for including related data in paginated responses
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Sources

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/sources

# Sources

Sources connect data in Propeller to the external system it came from. They prevent identifier conflicts when multiple systems integrate with the same Propeller environment.

A source consists of two fields:

- **`source`**: the name of the external system, typically the name of a supplier or ERP system the data originates from (for example `MBC` for Microsoft Business Central)
- **`sourceId`**: the unique identifier of the resource in that system

The combination of `source` and `sourceId` must be unique within the tenant. This means two different systems can use the same identifier without conflict:

A customer with ID `12345` in Microsoft Business Central:

```json
{
  "sourceId": "12345",
  "source": "MBC",
  "name": "Company ABC"
}
```

The same ID `12345` in Exact Online is a separate record because the `source` differs:

```json
{
  "sourceId": "12345",
  "source": "EXACTONLINE",
  "name": "Company XYZ"
}
```

## Source representation patterns

The Propeller REST API uses two patterns for representing sources depending on the context.

### Creating resources

When creating a resource, pass `source` and `sourceId` as direct fields in the request body:

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "source": "MBC",
  "sourceId": "3002196"
}
```

When `sourceId` is provided, `source` is required. When `source` is provided, `sourceId` is required.

### Reading resources

GET responses return sources as an array of source objects:

```json
{
  "id": 12345,
  "name": "John Doe",
  "email": "john@example.com",
  "sources": [
    {
      "source": "REST-API",
      "sourceId": "3002196"
    }
  ]
}
```

This applies to users, usergroups, customers, contacts, companies, products, categories, clusters and most other entities.

### Source objects

Some entities use a source object with `name` and `id` properties:

```json
{
  "productSource": {
    "name": "REST-API",
    "id": "T551284"
  }
}
```

This pattern is used in order items (`productSource`) and company references (`companySource`).

## Using sources in API operations

### Bulk operations

Bulk endpoints use the `source`/`sourceId` combination to decide whether to create or update a resource. If a resource with that combination already exists, it gets updated. If not, a new resource is created:

```
POST /v2/users/bulk/sourceId

{
  "contacts": [
    {
      "source": "MBC",
      "sourceId": "3002196",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com"
    }
  ]
}
```

### Lookup by source

You can retrieve resources using their source identifiers:

```
GET /v2/contacts/sourceId/3002196?source=MBC
```

### Parent references

When creating child resources, reference parents using their source information:

```json
{
  "source": "MBC",
  "sourceId": "3002198",
  "parent": {
    "sourceId": "x-123",
    "source": "MBC"
  },
  "firstName": "Jane",
  "lastName": "Smith"
}
```

## Naming conventions

Source names should be descriptive and consistent. Use uppercase for system names and avoid special characters that might cause URL encoding issues.

## See also

- [Lookup Keys](/integrations/integration-patterns/lookup-keys) for all available identifier types
- [Authentication and Security](/integrations/integration-patterns/authentication-and-security) for token management
- [REST API Reference](/reference/rest/endpoints/api-reference) for the full endpoint specification

---

## Sync Strategies

URL: https://docs.propeller-commerce.com/integrations/integration-patterns/sync-strategies

# Sync strategies

When you integrate an external system like an ERP or CRM with Propeller, you need a strategy for keeping data in sync on an ongoing basis. This page covers the most common patterns.

## Full sync vs delta sync

A **full sync** sends all records from the external system to Propeller in every run. This is the simplest approach and works well when the dataset is small enough to process within a reasonable time window. Because the bulk endpoints use upsert operations, they take care on their own if the action is create or update, so sending records that already exist in Propeller will update them rather than create duplicates.

A **delta sync** only sends records that have been created or modified since the last sync. This is useful when the dataset is large and a full sync would take too long or put unnecessary load on the source system. Delta syncs require the external system to support filtering by a date modified or date created field.

## Choosing a strategy

For most integrations the recommended approach is:

- **Daily full sync** when the dataset is manageable (for example up to a few thousand companies or contacts). This is the simplest option and ensures all data stays consistent.
- **Daily delta sync with periodic full sync** when the dataset is large. Run delta syncs daily to keep up with changes, and schedule a full sync weekly or monthly as a safety net to catch anything the delta syncs might have missed.

There is no difference in implementation between an initial import and an ongoing sync. The bulk endpoints handle both scenarios through their upsert behavior. You can use the same integration for your first import and for all subsequent syncs.

## Batch sizing

All bulk endpoints accept multiple records per request. Splitting your data into batches is recommended for two reasons: it keeps individual request payloads manageable and it makes debugging easier when something goes wrong.

Recommended batch sizes:

- **Companies, contacts and customers**: 100 to 200 per batch
- **Products with attributes**: roughly 100 per batch, depending on the amount of attribute data per product
- **Inventory**: although 1000 per batch is possible, 300 is a safer choice
- **Categories**: 100 to 200 per batch

Even when the endpoint can handle larger payloads, smaller batches make it easier to identify which records caused errors. Each batch is processed as a single database transaction, so if one record in a batch fails validation the entire batch is rolled back and none of its records are applied. Most errors are caught upfront by validation, before any data is written.

## Rate limits

The bulk endpoints are fast, so an integration that fires many requests in parallel can reach rate limits sooner than expected. If you run imports concurrently, cap the number of in-flight requests and back off when you receive a rate-limit response rather than retrying immediately.

## See also

- [Sources](/integrations/integration-patterns/sources) for how source combinations enable upsert behavior
- [REST API Reference](/reference/rest) for the full endpoint specifications

---

## Bulk import cost prices

URL: https://docs.propeller-commerce.com/integrations/recipes/bulk-import-cost-prices

# Bulk import cost prices

Import cost prices with quantity-based tiers for one or more products in a single call from an ERP or purchasing system.

## Endpoint

```
POST /v2/cost-prices/bulk
```

## Request

```json
{
  "bulkCostPrices": [
    {
      "productId": 6726,
      "value": 15.00,
      "quantityFrom": 1
    },
    {
      "productId": 6726,
      "value": 12.50,
      "quantityFrom": 10
    },
    {
      "productId": 6726,
      "value": 10.00,
      "quantityFrom": 50
    }
  ]
}
```

## Response

```json
{
  "created": 2,
  "updated": 1,
  "total": 3
}
```

## How it works

Use `POST /v2/cost-prices/bulk` to upsert cost prices for products. Each entry requires a `value` (the cost price) and a `quantityFrom` threshold. Send multiple entries for the same product to set up tiered pricing, for example a lower cost price when ordering 50 or more units. You can identify products by `productId` or by `source` using the source system's identifier. Add `validFrom` and `validTo` fields (ISO 8601 timestamps) to create time-bound cost prices for seasonal or contract-based pricing.

## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Bulk Import Cost Prices endpoint](/reference/rest/endpoints/cost-prices/cost-prices-bulk)
- [Bulk import prices (recipe)](/integrations/recipes/bulk-import-prices)

---

## Bulk import prices

URL: https://docs.propeller-commerce.com/integrations/recipes/bulk-import-prices

# Bulk import prices

Create or update prices for multiple products in a single call from an ERP or pricing system.

## Endpoint

```
POST /v2/prices/bulk
```

## Request

```json
{
  "prices": [
    {
      "productId": 6726,
      "list": 29.99,
      "store": 24.99,
      "defaultTaxCode": "H"
    },
    {
      "productId": 1600,
      "list": 49.50,
      "store": 39.99,
      "suggested": 59.99,
      "defaultTaxCode": "H",
      "per": 1
    }
  ]
}
```

## Response

```json
{
  "created": 0,
  "updated": 2,
  "total": 2
}
```

## How it works

Use `POST /v2/prices/bulk` to upsert prices for multiple products at once. Each entry requires a `list` price (the base selling price) and a `defaultTaxCode` (`H` for high, `L` for low, `N` for none). If a price record already exists for the product it gets updated, otherwise a new one is created. You can identify products by `productId` or by `productSource` using the source system's identifier.

## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Bulk Import Prices endpoint](/reference/rest/endpoints/prices/prices-bulk)
- [Bulk import cost prices (recipe)](/integrations/recipes/bulk-import-cost-prices)

---

## Create a category

URL: https://docs.propeller-commerce.com/integrations/recipes/create-a-category

# Create a category

Create a single product category in Propeller with localized names and a parent category reference.

## Endpoint

```
POST /v2/categories/
```

## Request

```json
{
  "names": [
    { "language": "EN", "value": "Power Tools" },
    { "language": "NL", "value": "Elektrisch gereedschap" }
  ],
  "descriptions": [
    { "language": "EN", "value": "Professional and consumer power tools" },
    { "language": "NL", "value": "Professioneel en consument elektrisch gereedschap" }
  ],
  "shortDescriptions": [
    { "language": "EN", "value": "Power tools" },
    { "language": "NL", "value": "Elektrisch gereedschap" }
  ],
  "source": "pim-akeneo",
  "sourceId": "CAT-TOOLS-001",
  "parent": {
    "id": 1736
  }
}
```

## Response

```json
{
  "data": {
    "id": 38614,
    "names": [
      { "language": "EN", "value": "Power Tools" },
      { "language": "NL", "value": "Elektrisch gereedschap" }
    ],
    "descriptions": [
      { "language": "EN", "value": "Professional and consumer power tools" },
      { "language": "NL", "value": "Professioneel en consument elektrisch gereedschap" }
    ],
    "shortDescriptions": [
      { "language": "EN", "value": "Power tools" },
      { "language": "NL", "value": "Elektrisch gereedschap" }
    ],
    "language": "EN",
    "source": "pim-akeneo",
    "sourceId": "CAT-TOOLS-001",
    "parent": {
      "id": 1736
    },
    "parentUuid": "019e9214-38f8-79a0-abb9-7b9b8d416309"
  },
  "messages": ["Category created successfully"],
  "total": 1
}
```

## How it works

The `parent` reference is optional. Include it to nest the category under another category, using `parent.id` to reference the parent by Propeller ID or `parent.sourceId` (with a `source` field on the parent object) to reference it by external identifier. Omit `parent` to create the category as a root category. The `source` and `sourceId` fields on the category itself let you tag it with your external system's identifier for future updates. Localized fields like `names`, `descriptions` and `shortDescriptions` accept an array of language objects. For bulk imports with tree structures, use `POST /v2/categories/bulk/sourceId` instead.

## See also

- [Import Categories (guide)](/integrations/domain-guides/products-and-categories/import-categories)
- [Sources](/integrations/integration-patterns/sources)
- [Authentication and security](/integrations/integration-patterns/authentication-and-security)

---

## Create a product

URL: https://docs.propeller-commerce.com/integrations/recipes/create-a-product

# Create a product

Create a new product in Propeller from an external system like a PIM, mapping external fields to Propeller's product model.

## Endpoint

```
POST /v2/products/
```

## Request

```json
{
  "names": [
    { "language": "EN", "value": "Wireless Bluetooth Headset Pro" },
    { "language": "NL", "value": "Draadloze Bluetooth Headset Pro" }
  ],
  "sku": "WBH-PRO-500",
  "status": "A",
  "descriptions": [
    { "language": "EN", "value": "<p>Professional wireless headset with noise cancellation and 24-hour battery life.</p>" },
    { "language": "NL", "value": "<p>Professionele draadloze headset met ruisonderdrukking en 24 uur batterijduur.</p>" }
  ],
  "shortDescriptions": [
    { "language": "EN", "value": "Wireless headset with ANC" },
    { "language": "NL", "value": "Draadloze headset met ANC" }
  ],
  "manufacturer": "AudioTech",
  "manufacturerCode": "AT-WBH-500",
  "eanCode": "8710000000123",
  "supplier": "TechDistri",
  "supplierCode": "TD-78901",
  "unit": 1,
  "minimumQuantity": 1,
  "source": "pim-akeneo",
  "sourceId": "PRD-00482"
}
```

## Response

```json
{
  "data": {
    "id": 98765,
    "names": [
      { "language": "EN", "value": "Wireless Bluetooth Headset Pro" },
      { "language": "NL", "value": "Draadloze Bluetooth Headset Pro" }
    ],
    "sku": "WBH-PRO-500",
    "status": "A",
    "manufacturer": "AudioTech",
    "manufacturerCode": "AT-WBH-500",
    "eanCode": "8710000000123",
    "supplier": "TechDistri",
    "supplierCode": "TD-78901",
    "source": "pim-akeneo",
    "sourceId": "PRD-00482"
  }
}
```

## How it works

Use `POST /v2/products/` to create a new product. Localized fields like `names`, `descriptions` and `shortDescriptions` accept an array of language objects. Set `status` to `A` (active) for products ready to sell, or `N` (new) for products still being enriched. The `source` and `sourceId` fields let you tag products with your external system's identifier, making it easy to look them up later without storing Propeller IDs in your PIM.


Creating a product sets up the product record only. Pricing and inventory are managed through separate endpoints. To make a product orderable, you also need to set up inventory using the inventory endpoints.


## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Create Product endpoint](/reference/rest/endpoints/product-management/create-product)
- [Update a product by lookup key (recipe)](/integrations/recipes/update-a-product-by-lookup-key)

---

## Create a shipment

URL: https://docs.propeller-commerce.com/integrations/recipes/create-a-shipment

# Create a shipment

Create a shipment for an order and attach a track and trace code so the customer can follow their delivery.

## Endpoint

```
POST /v2/orders/shipments
```

## Request

```json
{
  "orderId": 20131,
  "status": "IN_TRANSIT",
  "expectedDeliveryAt": "2026-03-26T14:00:00.000Z",
  "items": [
    {
      "orderItemId": 30565,
      "quantity": 2,
      "name": "Wireless Bluetooth Headset Pro",
      "sku": "WBH-PRO-500"
    }
  ],
  "trackAndTraces": [
    {
      "code": "3SYZTR20394857",
      "carrierId": 1
    }
  ]
}
```

## Response

```json
{
  "id": "432b65ee-9b2e-4c1c-951d-0cc6e3e37349",
  "orderId": 20131,
  "status": "IN_TRANSIT",
  "expectedDeliveryAt": "2026-03-26T14:00:00.000Z",
  "createdAt": "2026-03-24T11:06:21.579Z",
  "lastModifiedAt": "2026-03-24T11:06:21.579Z",
  "items": [
    {
      "id": "50dd3075-a113-409c-bb5a-633b0160570a",
      "shipmentId": "432b65ee-9b2e-4c1c-951d-0cc6e3e37349",
      "orderItemId": 30565,
      "quantity": 2,
      "name": "Wireless Bluetooth Headset Pro",
      "sku": "WBH-PRO-500",
      "createdAt": "2026-03-24T11:06:21.579Z",
      "lastModifiedAt": "2026-03-24T11:06:21.579Z"
    }
  ],
  "trackAndTraces": [
    {
      "id": "b29acd7b-4031-4b6a-9510-d2451f5eb9fc",
      "shipmentId": "432b65ee-9b2e-4c1c-951d-0cc6e3e37349",
      "code": "3SYZTR20394857",
      "carrierId": 1,
      "createdAt": "2026-03-24T11:06:21.579Z",
      "lastModifiedAt": "2026-03-24T11:06:21.579Z"
    }
  ]
}
```

## How it works

Use `POST /v2/orders/shipments` to create a shipment linked to an order. Each shipment contains one or more items (referencing order item IDs) and optionally one or more track and trace entries. The `status` field accepts values like `CREATED`, `IN_TRANSIT`, `DELIVERED` and `CANCELED`. For split shipments, create multiple shipments for the same order, each covering a subset of the order items.

## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Create Shipment endpoint](/reference/rest/endpoints/orders/create-shipment)
- [Update order status (recipe)](/integrations/recipes/update-order-status)

---

## Create an order

URL: https://docs.propeller-commerce.com/integrations/recipes/create-an-order

# Create an order

Create an order in Propeller from an external system like an ERP or marketplace, including line items, addresses, payment and shipping data.

## Endpoint

```
POST /v2/orders
```

## Request

```json
{
  "userId": 174112,
  "email": "customer@example.com",
  "currency": "EUR",
  "language": "NL",
  "type": "dropshipment",
  "status": "NEW",
  "items": [
    {
      "class": "product",
      "productId": 408,
      "quantity": 3,
      "sku": "WBH-PRO-500",
      "name": "Wireless Bluetooth Headset Pro",
      "originalPrice": 89.95,
      "price": 89.95,
      "priceTotal": 269.85,
      "taxPercentage": 21,
      "taxCode": "H",
      "isBonus": "N"
    }
  ],
  "paymentData": {
    "net": 269.85,
    "gross": 326.52,
    "tax": 56.67,
    "taxPercentage": 21,
    "method": "invoice",
    "status": "unknown",
    "overruled": "N"
  },
  "postageData": {
    "method": "DELIVERY",
    "taxPercentage": 21,
    "gross": 6.95,
    "net": 5.74,
    "tax": 1.21,
    "carrier": "PostNL",
    "partialDeliveryAllowed": "N",
    "overruled": "N"
  },
  "total": {
    "gross": 276.80,
    "net": 332.26,
    "tax": 55.46,
    "discountType": "N",
    "discountValue": 0
  },
  "addresses": [
    {
      "type": "invoice",
      "firstName": "Jan",
      "lastName": "de Vries",
      "company": "Voorbeeld B.V.",
      "street": "Keizersgracht",
      "number": "100",
      "postalCode": "1015AA",
      "city": "Amsterdam",
      "country": "NL",
      "gender": "M",
      "icp": "N"
    },
    {
      "type": "delivery",
      "firstName": "Jan",
      "lastName": "de Vries",
      "company": "Voorbeeld B.V.",
      "street": "Keizersgracht",
      "number": "100",
      "postalCode": "1015AA",
      "city": "Amsterdam",
      "country": "NL",
      "gender": "M",
      "icp": "N"
    }
  ]
}
```

## Response

```json
{
  "id": 20130,
  "uuid": "019d1f84-c51e-733f-9043-cb02100d2cb8",
  "status": "NEW",
  "type": "dropshipment",
  "email": "customer@example.com",
  "currency": "EUR",
  "language": "NL",
  "date": "2026-03-24T11:04:48.159Z",
  "createdAt": "2026-03-24T11:04:48.159Z",
  "postageData": {
    "method": "DELIVERY",
    "taxPercentage": 21,
    "gross": 6.95,
    "net": 5.74,
    "tax": 1.21,
    "partialDeliveryAllowed": "N",
    "overruled": "N",
    "carrier": "PostNL"
  },
  "paymentData": {
    "net": 269.85,
    "gross": 326.52,
    "tax": 56.67,
    "taxPercentage": 21,
    "method": "invoice",
    "status": "unknown",
    "overruled": "N"
  },
  "total": {
    "gross": 276.80,
    "net": 332.26,
    "tax": 55.46,
    "discountValue": 0,
    "discountType": "N"
  },
  "addresses": [
    {
      "type": "invoice",
      "firstName": "Jan",
      "lastName": "de Vries",
      "company": "Voorbeeld B.V.",
      "street": "Keizersgracht",
      "number": "100",
      "postalCode": "1015AA",
      "city": "Amsterdam",
      "country": "NL",
      "id": 34861,
      "orderId": 20130
    },
    {
      "type": "delivery",
      "firstName": "Jan",
      "lastName": "de Vries",
      "company": "Voorbeeld B.V.",
      "street": "Keizersgracht",
      "number": "100",
      "postalCode": "1015AA",
      "city": "Amsterdam",
      "country": "NL",
      "id": 34862,
      "orderId": 20130
    }
  ],
  "userId": 174112,
  "exportedAt": null,
  "exportStatus": "",
  "exportMessage": null
}
```

## How it works

The request requires a valid `userId` that exists in Propeller. The `items` array contains line items with product references, quantities and pricing. Each item needs `class` set to `product`, a `productId` or `sku` to identify the product, and pricing fields including `originalPrice`, `price`, `priceTotal` and `taxPercentage`. The `addresses` array must include at least one `invoice` and one `delivery` address. If the order is imported from an external system and should not be re-exported, set `exportStatus` to `exported` on creation to prevent export loops.

## See also

- [Import Orders (guide)](/integrations/domain-guides/orders/import-orders)
- [Export new orders (recipe)](/integrations/recipes/export-new-orders)
- [Authentication and security](/integrations/integration-patterns/authentication-and-security)

---

## Export new orders

URL: https://docs.propeller-commerce.com/integrations/recipes/export-new-orders

# Export new orders

Find orders that have not been exported yet and mark them as exported after the receiving system confirms receipt.

## Step 1: Search for unexported orders

### Endpoint

```
POST /v2/orders/search?expands=ORDER_ITEMS,ADDRESSES
```

### Request

```json
{
  "status": ["NEW"],
  "exportStatuses": []
}
```

### Response

```json
{
  "items": [
    {
      "id": 20106,
      "uuid": "019d1f2a-6cbb-7590-9f18-bf40ce127ec4",
      "status": "NEW",
      "type": "dropshipment",
      "email": "customer@example.com",
      "currency": "EUR",
      "language": "NL",
      "date": "2026-03-24T09:26:07.333Z",
      "postageData": {
        "method": "DELIVERY",
        "taxPercentage": 21,
        "gross": 7.25,
        "net": 5.99,
        "tax": 1.26,
        "partialDeliveryAllowed": "N",
        "overruled": "N"
      },
      "paymentData": {
        "net": 99.99,
        "gross": 121.99,
        "tax": 22,
        "taxPercentage": 21,
        "method": "rekening",
        "status": "unknown",
        "overruled": "N"
      },
      "total": {
        "gross": 129.24,
        "net": 105.98,
        "tax": 23.26,
        "discountValue": 0,
        "discountType": "A"
      },
      "items": [
        {
          "productId": 408,
          "sku": "#117",
          "name": "voorbeeld artikel",
          "quantity": 2,
          "originalPrice": 49.99,
          "price": 49.99,
          "priceTotal": 99.98,
          "taxPercentage": 21,
          "taxCode": "H",
          "id": 30539,
          "orderId": 20106
        }
      ],
      "addresses": [
        {
          "type": "invoice",
          "firstName": "Jan",
          "lastName": "de Vries",
          "company": "Voorbeeld B.V.",
          "street": "Keizersgracht",
          "number": "100",
          "postalCode": "1015AA",
          "city": "Amsterdam",
          "country": "NL"
        },
        {
          "type": "delivery",
          "firstName": "Jan",
          "lastName": "de Vries",
          "company": "Voorbeeld B.V.",
          "street": "Keizersgracht",
          "number": "100",
          "postalCode": "1015AA",
          "city": "Amsterdam",
          "country": "NL"
        }
      ],
      "userId": 174112,
      "exportedAt": null,
      "exportStatus": "",
      "exportMessage": null
    }
  ],
  "itemsFound": 720,
  "offset": 12,
  "page": 1,
  "pages": 60,
  "start": 1,
  "end": 12
}
```

## Step 2: Mark the order as exported

After the receiving system has processed the order, update it with export metadata so it does not appear in the next export run.

### Endpoint

```
PATCH /v2/orders/id/{id}
```

### Request

```
PATCH /v2/orders/id/20106
```

```json
{
  "exportedAt": "2026-03-24T10:00:00.000Z",
  "exportMessage": "ERP order id = 12355",
  "exportStatus": "exported"
}
```

### Response

```json
{
  "id": 20106,
  "status": "NEW",
  "exportedAt": "2026-03-24T10:00:00.000Z",
  "exportStatus": "exported",
  "exportMessage": "ERP order id = 12355"
}
```

## How it works

The search filter `exportStatuses: []` matches orders where no export status has been set. After you process each order, update it with `exportStatus`, `exportedAt` and `exportMessage`. The next search run will exclude these orders because they no longer have an empty export status. Use the `expands` query parameter to include order items and addresses in the search response so you get all the data you need in a single call.

## See also

- [Export orders (guide)](/integrations/domain-guides/orders/export-orders)
- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Pagination](/integrations/integration-patterns/pagination)

---

## Integration Recipes

URL: https://docs.propeller-commerce.com/integrations/recipes

# Integration Recipes

Raw REST API calls for common integration tasks. Each recipe solves one specific problem with copy-paste code.

---

## Update a product by lookup key

URL: https://docs.propeller-commerce.com/integrations/recipes/update-a-product-by-lookup-key

# Update a product by lookup key

Update an existing product without knowing the Propeller ID, using the source system's identifier as a lookup key.

## Endpoint

```
PATCH /v2/products/{lookupKey}/{lookupValue}
```

## Request

```json
{
  "names": [
    { "language": "EN", "value": "Wireless Bluetooth Headset Pro (2026)" }
  ],
  "status": "A",
  "manufacturerCode": "AT-WBH-500-V2"
}
```

## Response

```json
{
  "data": {
    "id": 98765,
    "names": [
      { "language": "EN", "value": "Wireless Bluetooth Headset Pro (2026)" },
      { "language": "NL", "value": "Draadloze Bluetooth Headset Pro" }
    ],
    "sku": "WBH-PRO-500",
    "status": "A",
    "manufacturer": "AudioTech",
    "manufacturerCode": "AT-WBH-500-V2",
    "source": "pim-akeneo",
    "sourceId": "PRD-00482"
  }
}
```

## How it works

Use `PATCH /v2/products/{lookupKey}/{lookupValue}` to update a product by its external identifier instead of the Propeller ID. This enables upsert-style sync patterns where your integration references products by the source system's ID. Only the fields you include in the request body are changed. Omitted fields keep their current values. The `source` query parameter scopes the lookup to a specific source system, so `sourceId` values from different systems don't collide.

## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Update Product by Lookup Key endpoint](/reference/rest/endpoints/product-management/update-product)
- [Create a product (recipe)](/integrations/recipes/create-a-product)

---

## Update order status

URL: https://docs.propeller-commerce.com/integrations/recipes/update-order-status

# Update order status

Mark an order as confirmed and flag it as exported to your ERP or fulfillment system.

## Endpoint

```
PATCH /v2/orders/id/{orderId}
```

## Request

```json
{
  "status": "CONFIRMED",
  "exportStatus": "exported",
  "exportedAt": "2026-03-24T12:00:00.000Z"
}
```

## Response

```json
{
  "id": 20131,
  "status": "CONFIRMED",
  "type": "dropshipment",
  "email": "warehouse@example.com",
  "currency": "EUR",
  "language": "EN",
  "date": "2026-03-24T11:04:56.730Z",
  "createdAt": "2026-03-24T11:04:56.730Z",
  "lastModifiedAt": "2026-03-24T11:04:56.942Z",
  "statusDate": "2026-03-24T11:04:56.938Z",
  "exportStatus": "exported",
  "exportedAt": "2026-03-24T12:00:00.000Z",
  "paymentData": {
    "method": "invoice",
    "status": "UNKNOWN",
    "gross": 59.99,
    "net": 49.58,
    "tax": 10.41,
    "taxPercentage": 21
  },
  "total": {
    "gross": 65.94,
    "net": 54.50,
    "tax": 11.44,
    "discountType": "A",
    "discountValue": 0
  }
}
```

## How it works

Use `PATCH /v2/orders/id/{orderId}` to update an order. Only the fields you include in the request body are changed. Status transitions are validated by Propeller, so only allowed transitions will succeed (for example, `NEW` to `CONFIRMED`). The `exportStatus` field accepts `exported`, `finished` or `failed` and is used together with `exportedAt` to track which orders have been synchronized to external systems like an ERP.

## See also

- [Authentication and security](/integrations/integration-patterns/authentication-and-security)
- [Update Order endpoint](/reference/rest/endpoints/orders/update-order)
- [Export new orders (recipe)](/integrations/recipes/export-new-orders)

---

## Business rules

URL: https://docs.propeller-commerce.com/platform/business-rules

Business rules are configurable logic blocks that determine how the platform behaves in specific scenarios. They control which carriers are available, how shipping costs are calculated, which payment methods are shown, what incentives apply and how transaction costs are determined.

Rules are created and managed through the Backoffice UI. Each rule type has its own page in the Admin sidebar (Shipping costs, Carriers, Payment methods, Incentives, Transaction costs). Partners do not need to build rules programmatically. The platform evaluates them automatically based on order data such as subtotal, delivery address, line items, user type and company.

## Rule types

Each business rule belongs to one of five types. Each type governs a specific domain of logic.

| Type | What it controls |
| --- | --- |
| Shipping costs | Calculates the shipping cost for an order based on conditions like delivery country, order subtotal or carrier |
| Carriers | Determines which carriers are available for the customer to choose from |
| Payment methods | Determines which payment methods are available for the customer to choose from |
| Incentives | Applies promotions such as bonus products, discount codes or order total discounts |
| Transaction costs | Calculates transaction fees based on the selected payment method or other conditions |

## How rules apply at runtime

Business rules are evaluated against the current state of the order. The platform passes order data (subtotal, addresses, line items, user, company) through each rule's decision table and applies the matching outputs.

### Cart (frontend checkout)

All five rule types are evaluated automatically on every cart change. When a customer adds an item, changes the delivery address or enters a discount code, the platform re-evaluates the applicable rules and updates the cart with the new carriers, shipping costs, payment methods and incentives.

### Tender (Sales Hub order and quote editor)

In the Sales Hub tender (order/quote editor), business rules are also evaluated automatically when data changes. The key differences from cart:

- **Incentives** must be triggered explicitly by the sales rep using the `tenderApplyIncentives` mutation. They are not applied automatically on every change
- **Most outcomes can be overwritten.** A sales rep can override shipping costs, select a different carrier or adjust payment terms manually. The `overruled` field (`Y` or `N`) on postage and payment data indicates whether the value was set by business rules or overridden by the sales rep

This gives sales reps flexibility to adjust quotes and orders while still benefiting from automated rule evaluation as a starting point.

## How rules are structured

Every business rule contains a decision table with rows called subrules. Each subrule has conditions (IF) and actions (THEN). When the conditions match, the actions are applied.

Rules use a hit policy to determine how multiple matching subrules are handled:

- **First** stops at the first matching subrule (top to bottom). Used when subrules are mutually exclusive or prioritized
- **All** evaluates every subrule and collects all matching outputs. Used when multiple results should stack (for example making several carriers selectable at the same time)

For details on building rules in the Backoffice, see [Rule editor](./rule-editor.md). For the output schema and examples per rule type, see [Rule types](./rule-types.md).

---

## Rule editor

URL: https://docs.propeller-commerce.com/platform/business-rules/rule-editor

Business rules are created and edited in the Backoffice. Each rule type has its own page in the Admin sidebar (Shipping costs, Carriers, Payment methods, Incentives, Transaction costs). This page explains the key concepts you will encounter in the rule editor.

## Creating a rule

To create a new rule:

1. Navigate to the relevant rule type page in the **Admin** section of the Backoffice sidebar (for example **Shipping costs** or **Incentives**)
2. Click **Add rule**
3. Give the rule a name using the pencil icon in the top left
4. Add subrules to define conditions and actions

## Rule structure

Each rule in the editor has:

- A **rule name** (editable with the pencil icon)
- A **hit policy toggle** in the top right corner: **first** or **all**
- An **Add subrule** button to add new rows to the decision table
- A **Save** button

## Subrules

Each subrule is a row in the decision table. It has a name, a set of conditions and a set of actions. Subrules are evaluated from top to bottom.

You can reorder subrules by dragging the handle on the left side. The order matters when the hit policy is set to **first** because the engine stops at the first matching subrule.

### Conditions (IF)

The IF section defines when the subrule matches. Each condition consists of:

- An **Item** dropdown that selects which field to evaluate (for example "Order subtotal" or "Order delivery address country")
- A **Condition** dropdown that selects the comparison operator (for example "equals", "greater than" or "contains")
- A **Value** field for the comparison value

You can add multiple conditions to a single subrule using the "Add condition" button. When a subrule has multiple conditions, an **and/or toggle** controls how they combine:

- **And** means all conditions must be true for the subrule to match
- **Or** means any one condition being true is enough

Leaving a condition empty matches any value.

#### User type

The User type condition accepts two values:

- `Contact` for B2B/company users
- `Customer` for B2C/individual users

These values are case-sensitive and must match exactly as shown.

#### Attribute conditions

Product, user and company attributes can be used as conditions. When referencing an attribute, always use its full name. Shortened names will not match.

| Correct | Incorrect |
| --- | --- |
| `PRODUCT_WEIGHT` | `WEIGHT` |
| `PRODUCT_SIZE` | `SIZE` |
| `PRODUCT_STOCK_QUANTITY` | `QUANTITY` or `STOCK_QUANTITY` |

**Product attribute nesting**

Product attribute conditions use a nested structure:

1. Set **Item** to "Order items" with Action = count, Condition = GreaterThanOrEqualTo, Value = 1
2. Set **Subitem** to "Product Attributes" with Action = count, Condition = GreaterThanOrEqualTo, Value = 1
3. Add nested conditions using the **and/or** toggle:
   - **Attribute Name** equals the full attribute name (for example `PRODUCT_WEIGHT`)
   - Then the attribute value condition (Attribute decimal value, Attribute text value or Attribute enum value)

**User and company attribute nesting**

User attributes follow the same pattern but start at Item = "User Attributes" (without the Order Items wrapper). Company attributes start at Item = "Company Attributes".

**Enum value operators**

When using enum attribute values as a condition, four operators are available:

| Operator | Behavior |
| --- | --- |
| All | Every attribute value must match the provided value |
| Contains | At least one attribute value must match the provided value |
| Some | At least one attribute value must match the provided value (same as Contains) |
| None | No attribute value should match the provided value |

### Actions (THEN)

The THEN section defines what happens when the conditions match. The available action fields vary by rule type:

- **Shipping costs** produces an action (set shipping costs) and a price
- **Carriers** produces an action (set carrier to selectable) and a carrier ID
- **Payment methods** produces an action (set payment method to selectable) and a payment method ID
- **Incentives** has the widest range of actions (see below)
- **Transaction costs** produces an action (set transaction costs) and a cost value

For the full output schema per rule type, see [Rule types](./rule-types.md).

## Hit policy

The hit policy determines how the engine handles multiple matching subrules. It is shown as a **first** / **all** toggle in the top right corner of the rule editor.

| Policy | Behavior |
| --- | --- |
| First | Stops at the first subrule that matches (top to bottom). Only that subrule's outputs are returned |
| All | Evaluates all subrules. Every matching subrule's outputs are collected and returned |

Use **first** when subrules are mutually exclusive or prioritized. For example, shipping cost rules typically use **first** because only one shipping cost should apply.

Use **all** when multiple results should stack. For example, carrier and payment method rules typically use **all** because multiple options should be available for the customer to choose from.

## Incentive actions

Incentive rules support the following actions:

| Action | Description |
| --- | --- |
| Add product to bonus items | Adds a product to the order as a bonus item (for example a free sample) |
| Give discount to order item | Applies a discount to specific order items that match the conditions |
| Give discount to order total | Applies a discount to the order total |
| Add valuepoints to order | Awards value points to the order |
| Set shipping costs | Sets shipping costs on the order. Useful for applying shipping discounts through incentive rules that are triggered explicitly in the Sales Hub |
| Set transaction costs | Sets transaction costs on the order. Same as shipping costs, useful for explicit incentive-based overrides |

The last two actions (set shipping costs and set transaction costs) overlap with the dedicated shipping cost and transaction cost rule types. The difference is that dedicated rules are evaluated automatically on every change, while incentive rules with these actions are only applied when incentives are triggered. In the Sales Hub this means a sales rep can explicitly apply a shipping discount as part of a quote or order negotiation.

## Repeat toggle (incentives)

Incentive subrules have a **Repeat** toggle on the action. It controls whether the action fires once per order or once per qualifying item. Repeat applies only to the discount and bonus item actions: give discount to order item, give discount to order total and add product to bonus items.

- **Repeat off**: the action fires a single time when the subrule matches. Use this for a flat discount or a single bonus item
- **Repeat on**: the action is applied for each qualifying item, so the result scales with the quantity ordered. Use this when a discount or bonus item should grow with the number of matching items

### Example: a bonus item that scales with quantity

To add one bonus item for every unit of a product ordered:

1. In the IF section, set **Item** to "Order items" with **Total Quantity**, Condition = GreaterThanOrEqualTo, Value = 1. This checks the quantity on the order line
2. In the THEN section, set the action to **Add product to bonus items** and select the bonus product
3. Turn the **Repeat** toggle on

With Repeat on, adding the product to the cart with quantity 4 adds 4 bonus items. With Repeat off, a single bonus item is added regardless of the quantity ordered.

## Fallback rows

The last subrule in a table is typically a fallback with a condition that is always true, for example "Order subtotal is greater than or equal to 0". This ensures the subrule always matches if no earlier subrule did.

This is useful for shipping cost rules where you want a default rate when no specific country or carrier condition applies.

## See also

- [Business rules overview](./index.md) for how rules apply at runtime
- [Rule types](./rule-types.md) for output schemas and practical examples

---

## Rule types

URL: https://docs.propeller-commerce.com/platform/business-rules/rule-types

Each business rule type has its own set of output fields. The conditions (IF side) use the same shared set of fields across all types. This page documents the available condition fields, the output schema per type and practical examples.

## Condition fields

All rule types evaluate conditions against the order context. The following fields are available in the condition dropdown when building subrules.

### Order fields

| Field | Type |
| --- | --- |
| Order subtotal | Number |
| Order action code (discount code) | String |
| Current date | Date |
| Postage shipping method | String |
| Postage carrier | String |
| Payment method | String |

### Address fields

Available for both delivery and invoice addresses.

| Field | Type |
| --- | --- |
| Country | String |
| City | String |
| Region | String |
| Postal code | String |

### User fields

| Field | Type |
| --- | --- |
| User type | String (`Contact` or `Customer`, case-sensitive) |
| First name | String |
| Last name | String |
| Birthday | Date |
| User attributes | Complex (nested) |

### Company fields

| Field | Type |
| --- | --- |
| Company name | String |
| Company ID | String |
| Debtor ID | String |
| Created at | Date |
| Company attributes | Complex (nested) |

### Order item fields (complex)

Order items are evaluated as a collection using a nested condition structure. At the top level, set the Item to "Order items" with a count threshold (for example count GreaterThanOrEqualTo 1). Then add sub-fields to filter which items are counted. For attribute-based conditions, see the [attribute nesting pattern](./rule-editor.md#attribute-conditions) in the rule editor guide. The available sub-fields are:

| Field | Type |
| --- | --- |
| Product SKU | String |
| Product manufacturer | String |
| Manufacturer code (OEM) | String |
| Supplier | String |
| Supplier code | String |
| Parent category ID | Number |
| Product ID | Number |
| Category path | Complex |
| Product name | Complex |
| Product attributes | Complex |

The aggregate fields available for output calculations are total quantity and total price.

## Shipping costs

Controls how much the customer pays for shipping.

**Typical hit policy:** First (only one shipping cost applies)

### Output fields

| Field | Description |
| --- | --- |
| Rule name | A localized label for the matched subrule |
| Action | `SET_SHIPPING_COSTS` |
| Price | The shipping cost value (in cents) |

### Example: shipping costs by country and subtotal

**Rule:** "Shipping costs" (hit policy: first)

This rule calculates shipping based on delivery country and order subtotal. Because the hit policy is first, the engine stops at the first matching subrule. Subrule order matters.

| Subrule | Conditions | Shipping cost |
| --- | --- | --- |
| Free shipping NL | Delivery country = "NL" AND subtotal ≥ €150 | €0.00 |
| Standard NL | Delivery country = "NL" | €6.95 |
| Belgium | Delivery country = "BE" | €9.95 |
| Germany | Delivery country = "DE" | €12.95 |
| Default (fallback) | Subtotal ≥ 0 | €19.95 |

Orders from the Netherlands above €150 get free shipping. Below that threshold, standard NL shipping applies. Belgium and Germany have flat rates. The fallback row uses a condition that is always true (subtotal ≥ 0), so any order not matching an earlier subrule gets the default international rate.

## Carriers

Controls which carriers the customer can choose from during checkout.

**Typical hit policy:** All (multiple carriers can be selectable at the same time)

### Output fields

| Field | Description |
| --- | --- |
| Rule name | A localized label for the matched subrule |
| Action | `SET_CARRIER_TO_SELECTABLE` |
| Carrier ID | The ID of the carrier to make available |

### Example: carriers by country

**Rule:** "Available carriers" (hit policy: all)

Each subrule makes one carrier selectable. Using different conditions controls which carriers appear for different delivery destinations.

| Subrule | Conditions | Carrier |
| --- | --- | --- |
| PostNL domestic | Delivery country = "NL" | PostNL |
| DHL domestic | Delivery country = "NL" | DHL |
| DHL Belgium | Delivery country = "BE" | DHL |
| DPD Belgium | Delivery country = "BE" | DPD |
| DHL international | Subtotal ≥ 0 | DHL |

Because the hit policy is **all**, every matching subrule contributes. A Dutch customer sees both PostNL and DHL. A Belgian customer sees DHL and DPD. All other countries only get DHL through the fallback row.

## Payment methods

Controls which payment methods the customer can choose from during checkout.

**Typical hit policy:** All (multiple payment methods can be selectable at the same time)

### Output fields

| Field | Description |
| --- | --- |
| Rule name | A localized label for the matched subrule |
| Action | `SET_PAYMENT_METHOD_TO_SELECTABLE` |
| Payment method ID | The ID of the payment method to make available |

### Example: payment methods by user type

**Rule:** "Payment methods" (hit policy: all)

| Subrule | Conditions | Payment method |
| --- | --- | --- |
| On account (B2B) | User type = "Contact" | On account |
| iDeal | Subtotal > 0 | iDeal |
| Visa | Subtotal ≥ 0 | Visa |
| Mastercard | Subtotal ≥ 0 | Mastercard |
| PayPal | Subtotal ≥ 0 | PayPal |

Because the hit policy is **all**, every matching subrule adds a payment method. "On account" is only available for company users. iDeal requires a subtotal above zero (it cannot process €0 payments). Visa, Mastercard and PayPal are available for all orders.

## Incentives

Controls promotions such as bonus products, discount codes and order total discounts. Incentives have the richest output schema of all rule types.

**Typical hit policy:** First (one incentive per rule)

In cart, incentives are applied automatically. In tender (Sales Hub), incentives must be triggered explicitly by the sales rep.

### Output fields

| Field | Description |
| --- | --- |
| Incentive name | A localized label for the matched subrule |
| Action | `ADD_PRODUCT_TO_BONUS_ITEMS`, `GIVE_DISCOUNT_TO_ORDER_ITEM`, `GIVE_DISCOUNT_TO_ORDER_TOTAL`, `ADD_VALUEPOINTS_TO_ORDER`, `SET_SHIPPING_COSTS` or `SET_TRANSACTION_COSTS` |
| Product ID | The product to add (for bonus item actions) |
| Quantity | How many to add |
| Price | Fixed price override (in cents) |
| Discount | Discount value |
| Discount type | `FlatFee` (flat amount) or `Percentage` |
| Value points | Value points to award |
| Repeat | Whether the action fires once per order or per qualifying item |
| Action code | The discount code that triggered the rule |

### Example: bonus product on high-value orders

**Rule:** "Free branded merchandise" (hit policy: first)

This rule adds a bonus product to orders above a certain threshold using the order subtotal as a condition.

| Subrule | Conditions | Action |
| --- | --- | --- |
| Premium gift | Subtotal ≥ €500 | Add bonus product, quantity 1, price €0, repeat off |
| Standard gift | Subtotal ≥ €100 | Add bonus product, quantity 1, price €0, repeat off |

Orders above €500 receive a premium gift. Orders between €100 and €500 receive a standard gift. Because the hit policy is **first**, only one bonus product is added. Subrule order matters here so that orders above €500 match the premium gift first.

### Example: discount code

**Rule:** "Summer campaign 2026" (hit policy: first)

| Subrule | Conditions | Action |
| --- | --- | --- |
| 10% summer discount | Order action code = "SUMMER10" | Give discount to order total, discount 10, type Percentage, repeat off |

When a customer enters the discount code "SUMMER10", a 10% discount is applied to the order total.

## Transaction costs

Controls transaction fees based on the selected payment method or other conditions.

**Typical hit policy:** First

The output schema follows a similar pattern to shipping costs with a rule name, action and cost value.

## See also

- [Business rules overview](./index.md) for how rules apply at runtime
- [Rule editor](./rule-editor.md) for building rules in the Backoffice

---

## Event actions

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration/event-action-manager

The Event Action Manager is a module that subscribes to events within the Propeller platform and executes actions with the event payload. You can execute multiple actions on the same event.

Two actions are currently supported: `SEND_EMAIL` and `POST_TO_WEBHOOK`.

### SEND_EMAIL

Triggers the [Template Module](./templates/templates-introduction.md) to render a template with the event payload and send it as email.

### POST_TO_WEBHOOK

Posts the event payload as a JSON POST request to a webhook endpoint.

## Supported events

### Order events

| Event | Description | Payload |
| --- | --- | --- |
| `ORDER_CREATED` | A new order or quote is created | Order |
| `ORDER_UPDATED` | An existing order or quote is updated | Order |
| `ORDER_DELETED` | An order or quote is deleted | Order ID only |
| `ORDER_BULK` | Batch operation on orders | Order |
| `ORDER_SEND_CONFIRMATION` | Order confirmation triggered during checkout or via the "Send order to client" button in the Sales Hub | Order |

### Quote events

| Event | Description | Payload |
| --- | --- | --- |
| `QUOTE_SEND` | A quote proposal is sent to the contact via the "Send to client" button in the Sales Hub | Order |
| `QUOTE_SEND_REQUEST` | Confirmation sent after a quote is requested by a customer from the frontend | Order |
| `QUOTE_SEND_VALIDATION` | A quote is sent to a senior account manager or sales manager for validation | Order |

### Company events

| Event | Description | Payload |
| --- | --- | --- |
| `COMPANY_CREATED` | A new company is created | Company |
| `COMPANY_UPDATED` | An existing company is updated | Company |
| `COMPANY_DELETED` | A company is deleted | Company |
| `COMPANY_BULK` | Batch operation on companies | Company |

### Contact events

| Event | Description | Payload |
| --- | --- | --- |
| `CONTACT_CREATED` | A new contact is created | Contact |
| `CONTACT_UPDATED` | An existing contact is updated | Contact |
| `CONTACT_DELETED` | A contact is deleted | Contact |
| `CONTACT_BULK` | Batch operation on contacts | Contact |
| `CONTACT_SEND_WELCOME_EMAIL` | Welcome email sent to a new contact | Contact |

### Customer events

| Event | Description | Payload |
| --- | --- | --- |
| `CUSTOMER_CREATED` | A new customer is created | Customer |
| `CUSTOMER_UPDATED` | An existing customer is updated | Customer |
| `CUSTOMER_DELETED` | A customer is deleted | Customer |
| `CUSTOMER_BULK` | Batch operation on customers | Customer |
| `CUSTOMER_SEND_WELCOME_EMAIL` | Welcome email sent to a new customer | Customer |

### Cart events

| Event | Description | Payload |
| --- | --- | --- |
| `CART_PURCHASE_AUTHORIZATION_REQUEST_SEND` | A purchase authorization request is sent to the authorization manager | Cart |

### Authentication events

| Event | Description | Payload |
| --- | --- | --- |
| `SEND_INIT_PASSWORD` | Initial password setup email sent to a contact or customer | PasswordReset |
| `SEND_RESET_PASSWORD` | Password recovery email sent to a contact or customer | PasswordReset |

### Other

| Event | Description | Payload |
| --- | --- | --- |
| `CUSTOM_EVENT` | User-defined event with a custom payload | CustomPayload |

## Event payloads

Below is an example payload for each event type.

### Order

```json
{
    "order": {
        "id": 1,
        "userId": 14644,
        "accountManagerId": null,
        "cartId": "01941780-c402-79ac-bade-0e9e37eb65c1",
        "channelId": 1,
        "shopId": 1,
        "uuid": "01941781-1cb2-7993-bb33-60ed9da34d64",
        "externalId": null,
        "debtorId": "ANONYMOUS",
        "status": "NEW",
        "type": "dropshipment",
        "source": "webshop",
        "email": "noreply@acme.nl",
        "emailDate": null,
        "remarks": null,
        "extra3": null,
        "extra4": null,
        "currency": "EUR",
        "currencyRatio": "1.00000",
        "language": "NL",
        "date": "2024-12-30T12:18:45.000Z",
        "statusDate": "2024-12-30T12:18:45.000Z",
        "postageData": {
        "method": "DELIVERY",
        "taxPercentage": "0.00",
        "requestDate": "2024-12-30T12:18:22.000Z",
        "gross": "2000.00000",
        "net": "2000.00000",
        "tax": 0,
        "partialDeliveryAllowed": "N",
        "pickUpLocationId": 0,
        "overruled": "Y",
        "carrier": "Mark delivery company"
        },
        "paymentData": {
            "net": "0.00000",
            "gross": "0.00000",
            "tax": "0.00000",
            "taxPercentage": "0.00",
            "method": "ACCOUNT",
            "status": "UNKNOWN",
            "statusDate": null,
            "overruled": "N",
            "accountingId": null
        },
        "total": {
            "gross": "2050.00000",
            "net": "2050.00000",
            "tax": "0.00000",
            "discountValue": "0.00000",
            "discountType": "N",
            "taxPercentages": []
        },
        "items": [
            {
                "id": 1,
                "uuid": "01941780-df79-75a3-83a5-b851ac114c0c",
                "class": "product",
                "productId": 1,
                "parentOrderItemId": null,
                "quantity": 1,
                "sku": "NCABD70004",
                "notes": null,
                "name": "Edge 1030 FietsComputer",
                "supplier": "TECHDATA",
                "supplierCode": "NCABD70004",
                "manufacturer": "Lavazza",
                "manufacturerCode": "NCABD70004",
                "eanCode": null,
                "originalPrice": "55.00000",
                "price": "50.00000",
                "priceTotal": "50.00000",
                "priceNet": "50.00000",
                "priceTotalNet": "50.00000",
                "customerPrice": "50.00000",
                "costPrice": "7.50000",
                "discount": "5.00000",
                "tax": "0.00000",
                "taxPercentage": "0.00000",
                "taxCode": "N",
                "isBonus": "N",
                "minimumQuantity": 1,
                "unit": 1,
                "package": "STK",
                "packageUnit": "",
                "packageUnitQuantity": "1",
                "purchaseUnit": 1,
                "purchaseMinimumQuantity": 1,
                "requestDate": null
            }
        ],
        "invoiceUserId": 14644,
        "validUntil": null,
        "companyId": null,
        "lastModifiedAt": "2024-12-30T12:18:45.048Z",
        "originalOrderId": 0,
        "exportedAt": null,
        "exportStatus": "",
        "exportMessage": null,
        "addresses": [
            {
                "firstName": "Sophie",
                "middleName": "",
                "lastName": "Bakker",
                "gender": "F",
                "company": "",
                "street": "Industrieweg",
                "number": "12",
                "numberExtension": "A",
                "postalCode": "4283 GZ",
                "city": "Giessen",
                "region": "Zuid-Holland",
                "country": "Netherlands",
                "phone": "+31 20 123 4567",
                "mobile": "+31 6 1234 5678",
                "email": "sophie@acme.nl",
                "code": "CUST-50123",
                "notes": "",
                "type": "invoice",
                "icp": "N"
            }
        ]
    }
}
```

### Contact

```json
{
  "contact": {
    "tenant": "acme",
    "id": 54321,
    "firstName": "Sophie",
    "middleName": "",
    "lastName": "Bakker",
    "phone": "+31 20 234 5678",
    "email": "sophie@acme.nl",
    "iban": "NL91ABNA0417164300",
    "bankAccount": "041716430",
    "bic": "ABNANL2A",
    "notes": "",
    "debtorId": "CONT-54321",
    "login": "sbakker",
    "gender": "F",
    "mobile": "+31 6 8765 4321",
    "expires": "2024-12-31T23:59:59.999Z",
    "externalId": "EXT-54321",
    "dateOfBirth": "1990-03-21T00:00:00.000Z",
    "mailingList": "Y",
    "createdAt": "2023-02-15T09:30:00.000Z",
    "lastModifiedAt": "2023-07-01T14:45:00.000Z",
    "company": {
      "id": 9876,
      "name": "Acme Corp B.V.",
      "taxNumber": "NL123456789B01",
      "cocNumber": "12345678",
      "debtorId": "COMP-9876",
      "phone": "+31 20 987 6543",
      "email": "info@acme.nl",
      "notes": "",
      "path": "/companies/acme-corp",
      "slug": "acme-corp",
      "tag": "wholesale",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "lastModifiedAt": "2023-06-30T12:00:00.000Z",
      "parentUsergroupId": 1000
    },
    "companies": [
      {
        "id": 9876,
        "name": "Acme Corp B.V.",
        "taxNumber": "NL123456789B01",
        "cocNumber": "12345678",
        "debtorId": "COMP-9876",
        "phone": "+31 20 987 6543",
        "email": "info@acme.nl",
        "notes": "",
        "path": "/companies/acme-corp",
        "slug": "acme-corp",
        "tag": "wholesale",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "lastModifiedAt": "2023-06-30T12:00:00.000Z",
        "parentUsergroupId": 1000
      },
      {
        "id": 5432,
        "name": "Merford Cabins B.V.",
        "taxNumber": "NL987654321B02",
        "cocNumber": "87654321",
        "debtorId": "COMP-5432",
        "phone": "+31 30 123 4567",
        "email": "info@merford.nl",
        "notes": "",
        "path": "/companies/merford-cabins",
        "slug": "merford-cabins",
        "tag": "manufacturing",
        "createdAt": "2021-06-15T00:00:00.000Z",
        "lastModifiedAt": "2023-05-20T10:30:00.000Z",
        "parentUsergroupId": 2000
      }
    ],
    "channelId": 3,
    "language": "NL"
  }
}
```

### Customer

```json
{
  "customer": {
    "tenant": "acme",
    "id": 12345,
    "debtorId": "CUST-12345",
    "gender": "M",
    "firstName": "Jan",
    "middleName": "de",
    "lastName": "Vries",
    "phone": "+31 20 123 4567",
    "mobile": "+31 6 9876 5432",
    "email": "jan@acme.nl",
    "login": "jdevries",
    "iban": "NL91ABNA0417164300",
    "bankAccount": "123456789",
    "bic": "ABNANL2A",
    "notes": "",
    "primaryLanguage": "NL",
    "expires": "2025-12-31T23:59:59.999Z",
    "externalId": "EXT-12345",
    "dateOfBirth": "1985-06-15T00:00:00.000Z",
    "mailingList": "Y",
    "isLoggedIn": true,
    "createdAt": "2023-01-01T10:00:00.000Z",
    "lastModifiedAt": "2023-06-30T15:30:00.000Z",
    "parentUsergroupId": 5,
    "channelId": 2,
    "language": "NL"
  }
}
```

### PasswordReset

```json
{
    "passwordReset": {
        "email": "jan@acme.nl",
        "resetLink": "https://www.acme.nl/reset-password",
        "language": "NL"
    }
}
```

## Webhook security

Two security methods are available for verifying webhook requests.

### HMAC signature verification

Propeller generates an HMAC-SHA256 signature using a secret salt that you configure. The signature is included in the `X-Propeller-Signature` header:

```
X-Propeller-Signature: sha256=<signature>
```

Your endpoint should compute the HMAC-SHA256 of the raw request body using the same secret and compare it against the header value to verify the request is authentic.

### Basic authentication

Propeller sends a username and password with each webhook request using HTTP Basic Authentication:

```
Authorization: Basic <base64-encoded credentials>
```

Both username and password must be provided together. The password is stored securely and is not displayed after saving.

---

## Event & Template Configuration

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration

This section covers two related platform features: event-driven actions and template rendering.

**Event actions** allow you to subscribe to platform events and execute actions with the event payload. Two action types are supported: `SEND_EMAIL` and `POST_TO_WEBHOOK`.

**Templates** are used to generate emails and PDF documents. They are rendered using Handlebars against a payload provided by the Event Action Manager.

---

## Handlebars helpers

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration/templates/handlebars-helpers

To make it easier to create templates, the built-in Handlebars helpers are extended with all helpers available in the [handlebars-helpers](https://github.com/helpers/handlebars-helpers) library.

Propeller also provides a few custom helpers for common template tasks.

## findObject

Gets an object from an array based on a key and value. Useful for merging data from your customQuery with the event payload.

The following example shows how to get an image (from your custom query) for each product in your order items. `#with` is a native Handlebars helper that scopes the result of `findObject` in a `product` variable.

```html
{{#each data.order.items}}
  <tr>
    <td>
      {{#with (findObject ../custom.products.items "productId" this.productId) as |product|}}
        {{!-- Now we have "product" instead of "this" --}}
        {{#if product}}
          <img src="{{product.media.images.items.[0].imageVariants.[0].url}}" />
        {{else}}
          <a href="http://www.propeller-commerce.com/img/image-not-found.png">
        {{/if}}
      {{/with}}
  </tr>
{{/each}}
```

## mapValues

Gets a list of values from an array based on a key of the objects in the array. Useful for extracting a list of productIds from the order items to use in your queryVariables.

```json
{ "productIds": [{{mapValues data.order.items "productId"}}] }
```

## toLocaleString

Converts any value into a locale string representation. Useful for displaying dates and numbers in currency format.

```html
<p>{{toLocaleString data.order.postageData.gross "nl-NL" style="currency" currency="EUR"}}</p>
```

## utcDateFormat

Converts a UTC date to a timezone-specific date.

```html
<p>{{#utcDateFormat data.order.date "Europe/Amsterdam" "DD-MM-YYYY HH:mm:ss" }}</p>
```

## glue

Joins multiple strings together with a delimiter (first argument). Removes extra whitespace created by null, undefined or empty values.

```html
<p>{{glue " " "string1" "string2" "string3"}}</p>
```

## HTML decoding with triple braces

Renders HTML content such as formatted text, HTML entities or markup from your data (e.g. `&amp;`, `&lt;`, `&gt;`, `&quot;`).

```html
<p>{{{company &amp; co}}}</p>
```

---

## Templates introduction

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration/templates/templates-introduction

The Template Module is a tool for managing templates that generate and send emails and generate PDF documents that can be attached to emails.

Templates are rendered using [Handlebars](https://handlebarsjs.com/) against a payload generated by the [Event Action Manager](../event-action-manager.md).

---

## Rendering templates

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration/templates/templates-rendering

Templates are rendered with payloads triggered by the [Event Action Manager](../event-action-manager.md). The incoming payload is scoped in a `data` object, so for an order payload the order data begins at `data.order`.

Details about the EventActionConfig that triggered the event are available under `config`.

### Using custom queries

In some cases you may need additional data that is not available in the original event payload. For instance when you want to personalize a password reset email or include product images in the order confirmation email.

You can enrich your data with a `customQuery`. The query is executed against the Propeller GraphQL API (with viewer role on all scopes). The `queryVariables` are the variables used in the GraphQL query. This field supports Handlebars variables and is the only field that is rendered with only the original event payload. Any other field with Handlebars support is rendered with a payload that also includes the results of the custom query. After rendering, the result of the `queryVariables` value must be a valid JSON string.

After the `customQuery` is executed, the results are scoped under `custom`.

#### Example

In this example we enrich a password reset email payload to include firstName, middleName, lastName and gender of the contact or customer so we can add a personalized salutation to the email.

The incoming event payload looks like this:

```json
{
    "data": {
        "passwordReset": {
            "email": "jan@acme.nl",
            "redirectLink": "https://www.acme.nl/reset-password",
            "language": "NL"
        }
    },
    "config": {
        "id": "56c30108-17b5-41ce-9841-1e587de30ad2",
        "emailTemplateId": "b51aa070-d08c-43da-8fc2-ce13a3cb2d77"
    }
}
```

Create a custom query to fetch the fields from the contact or customer from the GraphQL API based on the email address in the event payload:

```graphql
query resetPasswordCustom($login: String) {
    user(login: $login) {
        type: __typename
        email
        firstName
        lastName
        middleName
        gender
    }
}
```

Then add queryVariables that supply the `$login` variable from the event payload:

```json
{ "login": "{{data.passwordReset.email}}" }
```

After the `customQuery` executes, the complete payload used in all other Handlebars fields looks like this:

```json
{
    "data": {
        "passwordReset": {
            "email": "jan@acme.nl",
            "redirectLink": "https://www.acme.nl/reset-password",
            "language": "NL"
        }
    },
    "config": {
        "id": "56c30108-17b5-41ce-9841-1e587de30ad2",
        "emailTemplateId": "b51aa070-d08c-43da-8fc2-ce13a3cb2d77"
    },
    "custom": {
        "user": {
            "type": "Contact",
            "firstName": "Jan",
            "middleName": "de",
            "lastName": "Vries",
            "gender": "M"
        }
    }
}
```

This allows you to add a salutation in your template like this:

```html
<p>Dear {{#if (eq custom.user.gender "M")}}Sir{{else}}Madam{{/if}} {{glue " " custom.user.firstName custom.user.middleName custom.user.lastName}}</p>
```

### Preview and standalone rendering

The API can render and send templates standalone without the event triggering them. This is useful for previewing or rendering and sending a template as a standalone feature.

Since there is no event providing the payload in this case, you need to populate the payload yourself. The custom queries will still execute, so any dynamic variables in the `queryVariables` still need values that exist.

Three mutations are available:

| Mutation | Description |
| --- | --- |
| `templateRenderToHTML` | Renders the template content to HTML. Works for both `EmailTemplate` and `DocumentTemplate` |
| `emailTemplateRenderAndSend` | Renders the template and sends it as email. Useful for previewing the content in your email client. Uses the email template `tos`, `ccs` and `bccs` fields, so you may want to overwrite those to hardcoded values while testing |
| `documentTemplateRenderToPDF` | Renders the template to PDF and returns it as a Base64File object which includes the `fileName`, `base64` content and `contentType` (application/pdf) |

The input for these mutations consists of the `ID` of the template you want to render/send and a `TemplateRenderInput` which includes the payload as data. The JSON value is also scoped within a `data` variable, so you will need to create a nested data object in your custom payload. For example, the order payload would be at `data.data.order`.

---

## Types of templates

URL: https://docs.propeller-commerce.com/platform/event-and-template-configuration/templates/types-of-templates

There are two kinds of templates: `EmailTemplates` and `DocumentTemplates`.

Both templates share a set of common fields:

| Field | Description |
| --- | --- |
| ID | The ID of the template, UUID v7 format |
| Names | The display name of the template, per given language |
| Contents | A Handlebars template which outputs the HTML for the template, per given language |
| Custom Query | A custom GraphQL query that you can use to enrich the event payload data |
| Query variables | Variables used to execute the custom query. Supports Handlebars variables. The final result after rendering with Handlebars should be valid JSON. This is the only Handlebars field that is rendered only with the original event payload. Any other field with Handlebars support also includes the data fetched by the custom query |

### EmailTemplates

Email templates send an email based on the event payload and can be linked directly to an [Event Action](../event-action-manager.md).

Email templates include additional fields:

| Field | Description |
| --- | --- |
| Subject | The subject of the email, per given language. Supports Handlebars variables |
| From | The sender of the email. Consists of an email address and a name (the name can be translated into multiple languages) |
| Tos | An array of EmailContacts |
| Ccs | An array of EmailContacts |
| Bccs | An array of EmailContacts |
| Attachments | An array of document templates that will be rendered and attached as PDFs to the email |

#### EmailContact

| Field | Description |
| --- | --- |
| Email | The email address of the contact. Supports Handlebars variables |
| Name | (optional) The display name of the contact. Supports Handlebars variables |

### DocumentTemplates

Document templates generate PDF documents based on the event payload. They can be added to an EmailTemplate as an attachment or generated from dedicated mutations like `orderGetPDF` and `quoteGetPDF`. These methods select the document template with `isDefaultOrderPdf` or `isDefaultQuotePdf` respectively.

| Field | Description |
| --- | --- |
| FileNames | The proposed file name for the generated PDF document, per given language. Used as the file name when attached to an EmailTemplate and can be used in the `Content-Disposition` header when loading the template in the frontend |
| isDefaultOrderPdf | Indicates this template will be used when generating an order PDF in the Propeller Backoffice or when calling the `orderGetPDF` mutation in the API |
| isDefaultQuotePdf | Indicates this template will be used when generating a quote PDF in the Propeller Backoffice or when calling the `quoteGetPDF` mutation in the API |

---

## Platform

URL: https://docs.propeller-commerce.com/platform

# Platform

The platform section covers features and functionality built into the Propeller platform that work across all frontends and integrations.

## What you will find here

- [**Event and template configuration**](/platform/event-and-template-configuration/) explains how to set up event-driven actions and configure email templates using the template rendering engine
- [**Workflows and AI agents**](/platform/workflows-and-ai-agents/) describes how to register AI agents and connect them to external automation tools through webhooks
- [**Business rules**](/platform/business-rules/) covers the configurable logic that controls carriers, shipping costs, payment methods, incentives and transaction costs

---

## Agent configuration

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents/agent-configuration

Agents can be created and managed through the Backoffice UI at the **Agents** page in the Admin sidebar or programmatically via the GraphQL API using the `agents` query and related mutations.

## Agent properties

Each agent has the following properties:

### Identity

| Field | Description |
| --- | --- |
| `id` | Unique identifier |
| `names` | Localized display names (per language) |
| `descriptions` | Localized descriptions (per language) |
| `active` | Whether the agent is currently enabled |

### Behavior

| Field | Description |
| --- | --- |
| `trigger` | How the agent is activated: `CHAT` (user types a message) or `BUTTON` (user clicks an action button) |
| `interactionMode` | `MULTI_TURN` (supports follow-up messages) or `SINGLE_TURN` (one request, one response). Independent of trigger type |
| `types` | The UI contexts where the agent appears. Values must be in `SCREAMING_SNAKE_CASE` |

### Integration

| Field | Description |
| --- | --- |
| `webhookUrl` | The external endpoint that processes the agent's requests (required, max 2048 characters) |
| `webhookTimeoutMs` | Timeout in milliseconds for webhook requests (required) |

### UX

| Field | Description |
| --- | --- |
| `welcomeMessages` | Localized messages displayed when the agent is activated |
| `buttonLabels` | Localized labels for the agent's button in the UI |

## Built-in agent types

The Propeller UI uses the following agent types:

| Type | Where it appears |
| --- | --- |
| `SALES_HUB_QUOTE_EDITOR` | Quote editor in Sales Hub |
| `SALES_HUB_ORDER_EDITOR` | Order editor in Sales Hub |
| `SALES_HUB_QUOTE_REQUEST_EDITOR` | Quote request editor in Sales Hub |
| `SALES_HUB_COMPANY` | Company detail page |
| `BACKOFFICE_PRODUCTS` | Products and clusters page in PIM |

Implementation partners can also define custom types (for example `WEBSHOP_PRODUCT_DETAIL` or `FRONTEND_SHOPPING_BASKET`) for use in their own frontends. See [Embedding agents in your frontend](./embedding-in-frontends.md).

## Querying agents

Use the `agents` query to retrieve agents. You can filter by `types` and `active` status to retrieve only agents relevant to a specific view:

```graphql
query agents($input: AgentSearchInput) {
  agents(input: $input) {
    itemsFound
    items {
      id
      active
      names { language value }
      descriptions { language value }
      trigger
      interactionMode
      types
      webhookUrl
      webhookTimeoutMs
      welcomeMessages { language value }
    }
  }
}
```

```json
{
  "input": {
    "types": ["SALES_HUB_ORDER_EDITOR"],
    "active": true
  }
}
```

## Creating an agent

Agents are created with the `agentCreate` mutation. This is where you wire up the trigger type, the UI views it should appear in, the webhook endpoint and any security credentials.

### `AgentCreateInput` fields

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `names` | `[LocalizedStringInput!]!` | Yes | Display names. Unique language entries |
| `descriptions` | `[LocalizedStringInput!]` | No | Descriptions. Unique language entries |
| `welcomeMessages` | `[LocalizedStringInput!]` | No | Messages shown when the agent is activated |
| `buttonLabels` | `[LocalizedStringInput!]` | No | Labels for the agent button in the UI |
| `active` | `Boolean!` | Yes | Whether the agent is active on creation |
| `types` | `[String!]!` | Yes | UI contexts. Must be `SCREAMING_SNAKE_CASE` |
| `trigger` | `AgentTrigger!` | Yes | `CHAT` or `BUTTON` |
| `interactionMode` | `AgentInteractionMode!` | Yes | `SINGLE_TURN` or `MULTI_TURN` |
| `webhookUrl` | `String!` | Yes | Webhook endpoint. Max 2048 characters |
| `webhookTimeoutMs` | `Int!` | Yes | Webhook timeout in milliseconds |
| `webhookSignatureSalt` | `String` | No | Salt for HMAC-SHA256 payload signing |
| `webhookBasicAuthUsername` | `String` | No | Basic auth username. Must pair with password |
| `webhookBasicAuthPassword` | `String` | No | Basic auth password. Must pair with username |

### Mutation

```graphql
mutation agentCreate($input: AgentCreateInput!) {
  agentCreate(input: $input) {
    id
    active
    names { language value }
    descriptions { language value }
    trigger
    interactionMode
    types
    webhookUrl
    webhookTimeoutMs
    welcomeMessages { language value }
    createdAt
    lastModifiedAt
  }
}
```

### Example: Margin Validator agent

```json
{
  "input": {
    "names": [
      { "language": "NL", "value": "Margin Validator" }
    ],
    "descriptions": [
      { "language": "NL", "value": "Validates quote and order margins" }
    ],
    "trigger": "BUTTON",
    "interactionMode": "SINGLE_TURN",
    "active": true,
    "types": ["SALES_HUB_QUOTE_EDITOR"],
    "webhookUrl": "https://your-workflow-engine.com/webhook/margin-validator",
    "webhookTimeoutMs": 30000,
    "welcomeMessages": [
      {
        "language": "NL",
        "value": "This message is shown in the modal when opening the agent"
      }
    ],
    "webhookSignatureSalt": "your-secret-salt",
    "webhookBasicAuthUsername": "webhook-user",
    "webhookBasicAuthPassword": "webhook-pass"
  }
}
```

All three authentication fields are optional. You can use basic auth, signature verification, both or neither.

## Webhook authentication

### HMAC signature verification

When `webhookSignatureSalt` is configured, Propeller includes an `X-Propeller-Signature` header with every webhook request in the format `sha256=<hex-digest>`.

To verify the payload is authentic:

1. JSON-stringify the request payload
2. Generate an HMAC-SHA256 hash using the configured salt and the stringified payload
3. Compare the result with the received signature using a timing-safe comparison

### Basic authentication

When `webhookBasicAuthUsername` and `webhookBasicAuthPassword` are configured, Propeller adds a standard `Authorization: Basic ...` header to webhook requests. Both fields must be provided together or both omitted.

## See also

- [Conversations](./conversations.md) for trigger and interaction mode details
- [Webhook integration](./webhook-integration.md) for the webhook request/response contract
- [Embedding agents in your frontend](./embedding-in-frontends.md) for custom agent types

---

## Agent payloads

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents/agent-payloads

Each agent type receives a `requestMetadata.payload` object in the webhook request body containing the full context of the current view. The payload structure depends on the agent type. All payloads reflect the state of the object at the moment the agent dialog is opened.

## Webhook body structure

The top-level body sent to the webhook has the following fields:

| Field | Description |
| --- | --- |
| `type` | The agent type that triggered the request (for example `SALES_HUB_ORDER_EDITOR`) |
| `adminUserId` | The backoffice user who triggered the agent |
| `requestMessage` | The user's message. Present for chat agents, absent for button agents |
| `conversationId` | Absent on the first request. Present on follow-up messages in multi-turn conversations, carrying the value your webhook returned earlier |
| `requestMetadata.payload` | The full page context. Structure varies by agent type (see below) |

## Tender payload

Used by `SALES_HUB_QUOTE_EDITOR`, `SALES_HUB_ORDER_EDITOR` and `SALES_HUB_QUOTE_REQUEST_EDITOR`. Contains the full Tender object for the currently open quote, order or request.

### Top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `tenderId` | String | Primary identifier for the tender |
| `orderId` | Int | Order ID |
| `status` | String | Current order status (for example `QUOTATION`, `NEW`, `VALIDATED`) |
| `channelId` | Int | Sales channel ID |
| `source` | String | Order origin (for example `Sales Portal`, `Webshop`) |
| `email` | String | Contact email |
| `debtorId` | String | Debtor identifier |
| `invoiceUserId` | Int | Invoice user ID |
| `userId` | Int | User ID |
| `shopId` | Int | Shop ID |
| `createdAt` | DateTime | Creation timestamp |
| `reference` | String? | Customer reference |
| `remarks` | String? | Customer remarks |
| `externalId` | String? | External system ID |
| `validUntil` | DateTime? | Quote expiry date |
| `actionCode` | String? | Action code |
| `creditPoints` | Int? | Credit points |
| `valuePoints` | Int? | Value points |
| `incentivesApplied` | Boolean? | Whether incentives have been applied |

### Contact

| Field | Type | Description |
| --- | --- | --- |
| `contactId` | Int | Contact ID |
| `firstName` | String | First name |
| `middleName` | String | Middle name |
| `lastName` | String | Last name |
| `email` | String | Email address |
| `phone` | String | Phone number |
| `primaryLanguage` | String | Language code (for example `NL`) |
| `company` | Object | Nested company with `taxNumber` and `cocNumber` |
| `pricesheets` | Array | Assigned pricesheets |
| `purchaseAuthorizationConfigs` | Object | Purchase authorization configuration |

### Company

| Field | Type | Description |
| --- | --- | --- |
| `companyId` | Int | Company ID |
| `name` | String | Company name |
| `pricesheets` | Array | Assigned pricesheets with localized names |
| `addresses` | Array | Company addresses (delivery and invoice) |

### Addresses

The `deliveryAddress` and `invoiceAddress` objects share the same structure:

| Field | Type | Description |
| --- | --- | --- |
| `firstName` | String | First name |
| `middleName` | String | Middle name |
| `lastName` | String | Last name |
| `company` | String | Company name |
| `street` | String | Street name |
| `number` | String | House number |
| `numberExtension` | String | House number extension |
| `postalCode` | String | Postal code |
| `city` | String | City |
| `region` | String? | Region or province |
| `country` | String | Country code (for example `NL`, `CN`) |
| `email` | String | Email |
| `phone` | String | Phone |
| `mobile` | String? | Mobile phone |
| `gender` | String | Gender code |
| `icp` | String | Intra-community delivery flag (`Y` or `N`) |

### Items

The `items` array contains `TenderMainItem` objects representing order line items. Each main item can have `childItems` (accessories, options, surcharges) as `TenderBaseItem` objects.

**TenderMainItem fields:**

| Field | Type | Description |
| --- | --- | --- |
| `orderItemId` | Int | Order item ID |
| `uuid` | String | Unique item identifier |
| `productId` | Int | Product ID |
| `name` | String | Product name |
| `sku` | String | SKU |
| `quantity` | Int | Quantity |
| `price` | String | Unit price |
| `priceNet` | Number | Unit price including tax |
| `originalPrice` | Number | Original list price |
| `costPrice` | Number | Cost price |
| `customerPrice` | Number | Customer-specific price |
| `customerDiscountPercentage` | Number | Customer discount percentage |
| `discountPercentage` | String | Line item discount percentage |
| `marginAmount` | Number | Margin amount (price minus cost price) |
| `marginPercentage` | Number | Margin percentage |
| `saleMarginAmount` | Number | Sale margin amount |
| `saleMarginAmountSum` | Number | Sale margin amount including child items |
| `saleMarginPercentage` | Number | Sale margin percentage |
| `saleMarginPercentageSum` | Number | Sale margin percentage including child items |
| `attributedSaleDiscount` | Number | Attributed sale discount |
| `attributedSaleDiscountSum` | Number | Attributed sale discount including child items |
| `attributedSaleMargin` | String | Attributed sale margin |
| `attributedSaleMarginSum` | Number | Attributed sale margin including child items |
| `totalPrice` | Number | Total price (quantity × price) |
| `totalPriceNet` | Number | Total price including tax |
| `sum` | Number | Sum including child items |
| `sumNet` | Number | Sum including child items and tax |
| `totalSum` | Number | Total sum |
| `totalSumNet` | Number | Total sum including tax |
| `totalDiscountPercentage` | Number | Total discount percentage |
| `totalDiscountPercentageSum` | Number | Total discount percentage including child items |
| `taxCode` | String | Tax code (for example `H` for high, `N` for none) |
| `taxPercentage` | Number | Tax percentage |
| `supplier` | String | Supplier name |
| `supplierCode` | String | Supplier product code |
| `notes` | String | Item notes |
| `priority` | Int | Sort priority |
| `expectedDeliveryDate` | DateTime? | Expected delivery date |
| `incentive` | Object? | Applied incentive |
| `surcharges` | Array | Surcharges on the item |
| `valuePoints` | Int? | Value points |
| `childItems` | Array | Child items (accessories, options, surcharges) |

**Product details** (nested under each item):

| Field | Type | Description |
| --- | --- | --- |
| `product.productId` | Int | Product ID |
| `product.unit` | Int | Unit |
| `product.minimumQuantity` | Int | Minimum order quantity |
| `product.inventory.totalQuantity` | Int | Total available stock |
| `product.hasBundle` | String | Whether the product has a bundle (`Y` or `N`) |
| `product.isBundleLeader` | String | Whether the product is a bundle leader (`Y` or `N`) |
| `product.bundles` | Array | Available bundles with items |
| `product.crossupsellsFrom.itemsFound` | Int | Number of cross/upsell products |
| `product.cluster` | Object? | Cluster (configurable product) with names, SKU, options |
| `product.media.images` | Object | Product images with URLs |

**TenderBaseItem** (child items) has the same pricing and margin fields as TenderMainItem but without `childItems`, `priority`, `product` details and `surcharges`.

### Bonus items

The `bonusItems` array contains bonus products added by incentive rules. Empty when no incentives are applied.

### Carriers

| Field | Type | Description |
| --- | --- | --- |
| `name` | String | Carrier name |
| `id` | Int | Carrier ID |
| `amount` | Number | Shipping cost amount |
| `description` | String? | Carrier description |
| `logo` | String? | Carrier logo URL |

### Payment methods

| Field | Type | Description |
| --- | --- | --- |
| `code` | String | Payment method code (for example `IDEAL`, `INVOICE`) |
| `externalCode` | String | External payment method code |
| `type` | String | Type (for example `payment`) |
| `description` | String | Display name |
| `amount` | Number | Transaction cost |
| `allowed` | Boolean | Whether the method is allowed for this order |

### Payment data

| Field | Type | Description |
| --- | --- | --- |
| `method` | String | Selected payment method |
| `overruled` | String | Whether the transaction cost is overruled (`Y` or `N`) |
| `price` | Number | Transaction cost (gross) |
| `priceNet` | Number | Transaction cost (net) |
| `tax` | Number | Tax amount |
| `taxPercentage` | Number | Tax percentage |
| `status` | String | Payment status (for example `UNKNOWN`) |
| `statusDate` | DateTime? | Payment status date |
| `accountingId` | String? | Accounting reference |

### Postage data

| Field | Type | Description |
| --- | --- | --- |
| `carrier` | String? | Selected carrier name |
| `method` | String | Delivery method |
| `overruled` | String | Whether shipping cost is overruled (`Y` or `N`) |
| `price` | Number | Shipping cost (gross) |
| `priceNet` | Number | Shipping cost (net) |
| `taxPercentage` | Number | Tax percentage |
| `partialDeliveryAllowed` | String | Whether partial delivery is allowed (`Y` or `N`) |
| `pickUpLocationId` | Int? | Pick-up location ID |
| `requestDate` | DateTime? | Requested delivery date |
| `warehouse` | String? | Warehouse |

### Totals

| Field | Type | Description |
| --- | --- | --- |
| `subTotalGross` | Number | Subtotal (gross) |
| `subTotalNet` | Number | Subtotal (net, including tax) |
| `totalGross` | Number | Total (gross, including shipping and payment) |
| `totalNet` | Number | Total (net, including tax, shipping and payment) |
| `totalTax` | Number | Total tax amount |
| `discountGross` | Number | Total discount (gross) |
| `discountNet` | Number | Total discount (net) |
| `discountPercentage` | Number | Discount percentage |
| `discountOverruled` | String? | Whether discount is overruled |

### Revisions

| Field | Type | Description |
| --- | --- | --- |
| `itemsFound` | Int | Total number of revisions |
| `items[].revisionNumber` | Int | Revision number |
| `items[].createdAt` | DateTime | Revision creation timestamp |
| `items[].createdByAdminUser` | Object? | Admin user who created the revision (firstName, middleName, lastName) |
| `items[].createdByContact` | Object? | Contact who created the revision |
| `items[].createdByCustomer` | Object? | Customer who created the revision |
| `items[].snapshot.status` | String | Order status at time of revision |
| `items[].snapshot.type` | String | Order type at time of revision |
| `items[].snapshot.public` | Boolean | Whether the revision was public |

### Example tender payload

A trimmed example showing the key structure. Actual payloads contain all fields listed above.

```json
{
  "type": "SALES_HUB_ORDER_EDITOR",
  "adminUserId": 205,
  "requestMessage": "can you give me advice how to increase the order value?",
  "requestMetadata": {
    "payload": {
      "tenderId": "019d026b-99ce-7b94-b5cd-f5d436d23f78",
      "orderId": 3043,
      "status": "VALIDATED",
      "channelId": 1,
      "source": "Sales Portal",
      "email": "wouter@example.nl",
      "contact": {
        "contactId": 14780,
        "firstName": "Wouter",
        "lastName": "Smrkovsky",
        "email": "wouter@example.nl",
        "phone": "0592343043",
        "primaryLanguage": "NL",
        "company": {
          "taxNumber": "NL001607480B01",
          "cocNumber": "02009131"
        },
        "pricesheets": []
      },
      "company": {
        "companyId": 308,
        "name": "M&G Group",
        "pricesheets": [
          {
            "names": [{ "language": "NL", "value": "Contract M&G Group" }]
          }
        ],
        "addresses": [
          {
            "street": "Burgemeester Grollemanweg",
            "number": "14",
            "postalCode": "9405TN",
            "city": "Assen",
            "country": "NL",
            "type": "delivery"
          }
        ]
      },
      "deliveryAddress": {
        "street": "Burgemeester Grollemanweg",
        "number": "14",
        "postalCode": "9405TN",
        "city": "Assen",
        "country": "NL"
      },
      "items": [
        {
          "orderItemId": 29054,
          "name": "La Marzocco Linea Mini – Yellow",
          "sku": "2400015",
          "quantity": 1,
          "price": "4796.55",
          "costPrice": 3650,
          "customerPrice": 4796.55,
          "marginAmount": 1146.55,
          "marginPercentage": 31.41,
          "saleMarginPercentage": 23.90,
          "saleMarginPercentageSum": 35.36,
          "supplier": "Intern",
          "taxCode": "H",
          "taxPercentage": 21,
          "product": {
            "productId": 1020,
            "inventory": { "totalQuantity": 282 },
            "hasBundle": "N",
            "crossupsellsFrom": { "itemsFound": 0 },
            "cluster": {
              "clusterId": 74,
              "names": [{ "value": "La Marzocco Linea Mini", "language": "NL" }],
              "sku": "LAMALIMI"
            }
          },
          "childItems": [
            {
              "orderItemId": 29055,
              "name": "Walnut set for the Linea Mini",
              "sku": "1000121",
              "quantity": 1,
              "price": 585.37,
              "costPrice": 423.56,
              "marginAmount": 161.81,
              "marginPercentage": 38.20,
              "taxCode": "H",
              "taxPercentage": 21
            }
          ]
        }
      ],
      "bonusItems": [],
      "carriers": [
        { "name": "DHL", "id": 8, "amount": 2.36 },
        { "name": "PostNL", "id": 2, "amount": 4.50 }
      ],
      "payMethods": [
        { "code": "IDEAL", "description": "Ideal | Wero", "amount": 0, "allowed": true },
        { "code": "INVOICE", "description": "Betalen via factuur", "amount": 0, "allowed": true }
      ],
      "paymentData": {
        "method": "",
        "overruled": "N",
        "price": 35,
        "priceNet": 42.35,
        "status": "UNKNOWN",
        "taxPercentage": 21
      },
      "postageData": {
        "carrier": null,
        "method": "",
        "overruled": "N",
        "price": 10,
        "priceNet": 12.10,
        "taxPercentage": 21,
        "partialDeliveryAllowed": "Y"
      },
      "total": {
        "subTotalGross": 6246.94,
        "subTotalNet": 7558.80,
        "totalGross": 6291.94,
        "totalNet": 7613.25,
        "totalTax": 1321.31,
        "discountGross": 0,
        "discountNet": 0,
        "discountPercentage": 0
      },
      "revisions": {
        "itemsFound": 4,
        "items": [
          {
            "revisionNumber": 4,
            "createdAt": "2026-03-18T19:11:03.197Z",
            "createdByAdminUser": {
              "firstName": "Jasper",
              "lastName": "Pardijs"
            },
            "snapshot": {
              "status": "VALIDATED",
              "type": "dropshipment",
              "public": true
            }
          }
        ]
      }
    }
  }
}
```

## Company payload

Used by `SALES_HUB_COMPANY`. Contains the company object for the currently open company detail page.

### Top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `companyId` | Int | Company ID |
| `name` | String | Company name |
| `debtorId` | String? | External billing ID |
| `cocNumber` | String? | Chamber of Commerce number |
| `taxNumber` | String? | VAT/tax number |
| `email` | String? | Company email |
| `phone` | String? | Phone number |
| `notes` | String? | Internal notes |
| `contacts` | Object | Paginated list of contacts linked to this company |
| `addresses` | Array | Company addresses (delivery and invoice) |

### Contacts

The `contacts` object contains a paginated list of contacts linked to the company.

| Field | Type | Description |
| --- | --- | --- |
| `itemsFound` | Int | Total number of contacts linked to this company |
| `offset` | Int | Current page size |
| `page` | Int | Current page number |
| `items` | Array | Contact objects for the current page |

Each contact in `items` contains:

| Field | Type | Description |
| --- | --- | --- |
| `contactId` | Int | Contact ID |
| `firstName` | String | First name |
| `lastName` | String | Last name |
| `middleName` | String? | Middle name |
| `email` | String? | Email address |
| `phone` | String? | Phone number |
| `mobile` | String? | Mobile phone number |
| `primaryLanguage` | String? | Language code (for example `NL`, `EN`) |
| `mailingList` | String | Subscribed to mailing list (`Y` or `N`) |
| `login` | String? | Login identifier |

### Addresses

Each address in the `addresses` array contains:

| Field | Type | Description |
| --- | --- | --- |
| `id` | Int | Address ID |
| `firstName` | String | First name |
| `middleName` | String? | Middle name |
| `lastName` | String | Last name |
| `company` | String? | Company name on the address |
| `email` | String? | Email |
| `street` | String | Street name |
| `number` | String | House number |
| `numberExtension` | String? | House number extension |
| `postalCode` | String | Postal code |
| `city` | String | City |
| `region` | String? | Region or province |
| `country` | String | Country code (for example `NL`, `DE`) |
| `phone` | String? | Phone number |
| `mobile` | String? | Mobile phone number |
| `gender` | String | Gender code (`M`, `F` or `U`) |
| `icp` | String | Intra-community delivery flag (`Y` or `N`) |
| `isDefault` | String | Default address (`Y` or `N`) |
| `type` | String | Address type (`delivery` or `invoice`) |

### Example company payload

```json
{
  "type": "SALES_HUB_COMPANY",
  "adminUserId": 205,
  "requestMessage": "summarize this company",
  "requestMetadata": {
    "payload": {
      "companyId": 9876,
      "name": "Acme Corp B.V.",
      "email": "info@acme.nl",
      "taxNumber": "NL123456789B01",
      "cocNumber": "12345678",
      "debtorId": "COMP-9876",
      "notes": "",
      "phone": "+31 20 123 4567",
      "contacts": {
        "itemsFound": 5,
        "offset": 12,
        "page": 1,
        "items": [
          {
            "contactId": 54321,
            "firstName": "Sophie",
            "lastName": "Bakker",
            "middleName": "",
            "email": "sophie@acme.nl",
            "phone": "+31 20 234 5678",
            "mobile": "+31 6 8765 4321",
            "primaryLanguage": "NL",
            "mailingList": "N",
            "login": "sophie@acme.nl"
          },
          {
            "contactId": 12345,
            "firstName": "Jan",
            "lastName": "Vries",
            "middleName": "de",
            "email": "jan@acme.nl",
            "phone": "",
            "mobile": "+31 6 9876 5432",
            "primaryLanguage": "NL",
            "mailingList": "Y",
            "login": "jan@acme.nl"
          }
        ]
      },
      "addresses": [
        {
          "id": 34766,
          "firstName": "Jan",
          "middleName": "de",
          "lastName": "Vries",
          "company": "Acme Corp B.V.",
          "email": "jan@acme.nl",
          "city": "Giessen",
          "country": "NL",
          "gender": "M",
          "icp": "N",
          "isDefault": "Y",
          "number": "12",
          "numberExtension": "A",
          "mobile": "+31 6 9876 5432",
          "phone": "+31 20 123 4567",
          "postalCode": "4283 GZ",
          "region": "Zuid-Holland",
          "street": "Industrieweg",
          "type": "delivery"
        },
        {
          "id": 34772,
          "firstName": "Sophie",
          "middleName": "",
          "lastName": "Bakker",
          "company": "Acme Corp B.V.",
          "email": "sophie@acme.nl",
          "city": "Utrecht",
          "country": "NL",
          "gender": "F",
          "icp": "N",
          "isDefault": "Y",
          "number": "34",
          "numberExtension": "",
          "mobile": "+31 6 8765 4321",
          "phone": "+31 20 234 5678",
          "postalCode": "3511 AB",
          "region": "Utrecht",
          "street": "Kerkstraat",
          "type": "invoice"
        }
      ]
    }
  }
}
```

## Products payload

Used by `BACKOFFICE_PRODUCTS`. Contains a summary of the current product list view.

| Field | Type | Description |
| --- | --- | --- |
| `totalItems` | Int | Total number of products and clusters matching the current filter |

### Example products payload

```json
{
  "type": "BACKOFFICE_PRODUCTS",
  "adminUserId": 205,
  "requestMessage": "how many products do we have?",
  "requestMetadata": {
    "payload": {
      "totalItems": 12185
    }
  }
}
```

## Custom frontend payloads

Custom agent types (for example `WEBSHOP_PRODUCT_DETAIL` or `CUSTOMER_PORTAL_ORDERS`) have no fixed payload structure. You build the `requestMetadata.payload` yourself with whatever data your webhook needs. See [Embedding agents in your frontend](./embedding-in-frontends.md) for details.

## Response format

The webhook must return a JSON object. `responseMessage` is always required. For multi-turn agents `conversationId` is required too: your webhook generates it on the first response (the first request contains none) and echoes the incoming value back on follow-ups. The structure of `responseMetadata` is entirely up to you and depends on what your workflow does.

| Field | Required | Description |
| --- | --- | --- |
| `conversationId` | For multi-turn | Generated by your webhook on the first response, echoed back on follow-ups. Without it, follow-up messages cannot be linked to the conversation. Can be omitted for single-turn agents |
| `responseMessage` | Yes | Text displayed to the user in the UI. Supports newlines for formatting |
| `responseMetadata` | No | Freeform object. Use it to pass structured data back to the UI or downstream systems. The contents are entirely defined by your workflow |

### Example response

```json
{
  "conversationId": "4308",
  "responseMessage": "The result of your workflow, displayed to the user.",
  "responseMetadata": {
    "anyKey": "anyValue"
  }
}
```

## See also

- [Conversations](./conversations.md) for the conversation lifecycle
- [Webhook integration](./webhook-integration.md) for building the webhook backend
- [Agent configuration](./agent-configuration.md) for setting up agents and webhook credentials

---

## Conversations

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents/conversations

When a user interacts with an agent, Propeller creates a conversation. The conversation handles sending page context to the webhook and displaying the response. How the conversation starts and whether it supports follow-up messages depends on the agent's trigger type and interaction mode.

## Trigger and interaction mode

Trigger type (`CHAT` or `BUTTON`) and interaction mode (`SINGLE_TURN` or `MULTI_TURN`) are fully independent settings. All four combinations are valid:

| Trigger | Mode | Behavior |
| --- | --- | --- |
| CHAT | SINGLE_TURN | User sends one message, gets one response. No follow-up |
| CHAT | MULTI_TURN | User sends messages back and forth in an ongoing conversation |
| BUTTON | SINGLE_TURN | User clicks a button, gets one response immediately |
| BUTTON | MULTI_TURN | User clicks a button to trigger the first interaction, then continues chatting in the modal that opens |

### Chat trigger

A chat-triggered agent presents a text input where the user types a message. In single-turn mode the agent responds once and the conversation ends. In multi-turn mode the user can keep asking follow-up questions.

**Example:** An "AI Sales Assistant" (CHAT + MULTI_TURN) that helps a sales rep find cross-sell opportunities on an order through back-and-forth conversation.

### Button trigger

A button-triggered agent fires when the user clicks it. In single-turn mode the result is displayed immediately with no further interaction. In multi-turn mode the button opens a modal where the user can continue the conversation after the initial response.

**Example:** A "Margin Validator" (BUTTON + SINGLE_TURN) that analyzes margins on a quote and returns an instant approval or rejection.

## How context is passed

When an agent is invoked, Propeller sends a `requestMetadata.payload` object to the webhook containing the full context of the current view. In the built-in Sales Hub and Backoffice this payload is assembled automatically. When embedding agents in a custom frontend you build the payload yourself (see [Embedding agents in your frontend](./embedding-in-frontends.md)).

For Sales Hub and Backoffice agent types the payload includes the full context of the current view: order/quote data with line items, pricing, margins, customer and company information, addresses, available carriers and payment methods, and revision history.

The agent's webhook receives all of this so the external workflow can usually make informed decisions without extra API calls. When a workflow needs more than the page context, it can call the Propeller API with its own API key, for example to look up a company's recent orders or to modify the quote the user is viewing before it responds. For the complete field reference per agent type, see [Agent payloads](./agent-payloads.md).

For chat agents the user's message is included as `requestMessage`. For button agents no user message is needed since the action is implicit.

## Starting a conversation

Create a new conversation with `agentConversationCreate`. This sends the agent ID, the current page context and (for chat agents) the user's first message to the webhook.

```graphql
mutation AgentConversationCreate($input: AgentConversationCreateInput!) {
  agentConversationCreate(input: $input) {
    id
    messages {
      conversationId
      responseMessage
      responseMetadata
    }
  }
}
```

The response includes the agent's first reply. The `responseMessage` is the text shown to the user. The `responseMetadata` can contain structured data (for example margin calculations, approval status or timestamps).


The first webhook request contains no `conversationId`. Your webhook generates one (any unique, non-blank string) and returns it in the `conversationId` field of its response. Propeller passes it back to your frontend in `messages[].conversationId`. This is because the conversation state lives in your workflow, so your workflow owns the identifier it stores that state under. Without a `conversationId` in the first webhook response, follow-up messages cannot be linked to the conversation.

Note that the conversation record's own `id` is a different value. For follow-up messages, use the `conversationId` from `messages`, not the conversation `id`.


## Continuing a conversation

For multi-turn agents, send subsequent messages with `agentMessageCreate` using the `conversationId` your webhook returned in the first response:

```graphql
mutation AgentMessageCreate($input: AgentMessageCreateInput!) {
  agentMessageCreate(input: $input) {
    conversationId
    responseMessage
    responseMetadata
  }
}
```

The full page context is sent again with each message so the webhook always has up-to-date information. Each follow-up request to the webhook includes the `conversationId`, so the workflow can look up its conversation state and echo the same value back in its response.

## See also

- [Agent configuration](./agent-configuration.md) for setting up trigger types and interaction modes
- [Agent payloads](./agent-payloads.md) for the complete field reference per agent type
- [Webhook integration](./webhook-integration.md) for the request/response format

---

## Embedding agents in your frontend

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents/embedding-in-frontends

Agents are not limited to the Propeller Sales Hub and Backoffice. As an implementation partner you can embed agents in any custom frontend (webshop, customer portal, mobile app) by defining your own agent types and using the GraphQL conversation API.

## How custom types work

The `types` field on an agent accepts any value in `SCREAMING_SNAKE_CASE` format. The built-in types like `SALES_HUB_ORDER_EDITOR` are conventions used by the Propeller UI. You can create agents with custom types that only your frontend knows about.

## Step 1: Create an agent with a custom type

Use the Backoffice Agents page or the `agentCreate` mutation. The type can be anything you define:

```json
{
  "input": {
    "names": [{ "language": "EN", "value": "Shopping Assistant" }],
    "descriptions": [{ "language": "EN", "value": "Helps customers with product questions" }],
    "trigger": "CHAT",
    "interactionMode": "MULTI_TURN",
    "active": true,
    "types": ["FRONTEND_SHOPPING_BASKET"],
    "webhookUrl": "https://your-workflow-engine.com/webhook/shopping-assistant",
    "webhookTimeoutMs": 15000,
    "welcomeMessages": [
      { "language": "EN", "value": "Hi! Need help with your order?" }
    ]
  }
}
```

## Step 2: Query agents from your frontend

On page load (or when a chat component mounts) query for active agents matching your custom type:

```graphql
query agents($input: AgentSearchInput) {
  agents(input: $input) {
    items {
      id
      names { language value }
      trigger
      interactionMode
      welcomeMessages { language value }
      buttonLabels { language value }
    }
  }
}
```

```json
{
  "input": {
    "types": ["FRONTEND_SHOPPING_BASKET"],
    "active": true
  }
}
```

This returns all agents configured for your shopping basket view. You might get a chat assistant and a "Check stock availability" button agent.

## Step 3: Render in your UI

How you present the agents is up to you. Some patterns:

- Display chat agents as a floating chat widget or inline chat panel
- Display button agents as action buttons in a toolbar or card
- Use `welcomeMessages` as the initial greeting in a chat bubble
- Use `buttonLabels` as the button text
- Show or hide agents based on user role, cart contents or any other frontend logic

## Step 4: Start and continue conversations

When the user interacts with an agent, call `agentConversationCreate` with the agent ID and the relevant page context. You build the `requestMetadata.payload` yourself with whatever data the webhook needs:

```graphql
mutation AgentConversationCreate($input: AgentConversationCreateInput!) {
  agentConversationCreate(input: $input) {
    id
    messages {
      conversationId
      responseMessage
      responseMetadata
    }
  }
}
```

The `requestMetadata.payload` is freeform. In the Propeller Backoffice it contains the full order data, but in your frontend you can pass anything: cart contents, product details, user preferences or whatever your webhook needs to generate a useful response.

For multi-turn agents, send follow-up messages with `agentMessageCreate` using the `conversationId` from `messages` in the first response. Your webhook generates this value on its first response, Propeller does not create it. See [Conversations](./conversations.md#continuing-a-conversation) for how the identifier flows between your frontend and your webhook.

## Example: custom types for a webshop

A single webshop might use several custom agent types across different pages:

| Custom Type | Where | Example Agent |
| --- | --- | --- |
| `WEBSHOP_PRODUCT_DETAIL` | Product page | "Ask about this product" chat |
| `WEBSHOP_SHOPPING_BASKET` | Cart page | "Check delivery time" button |
| `WEBSHOP_CHECKOUT` | Checkout flow | "Apply best discount" button |
| `CUSTOMER_PORTAL_ORDERS` | Order history | "Track my order" chat |
| `CUSTOMER_PORTAL_RETURNS` | Returns page | "Start a return" button + chat |

Each type maps to a different set of agents with different webhook backends. The frontend queries for the right type on each page and renders whatever comes back.

## See also

- [Agent configuration](./agent-configuration.md) for creating agents with custom types
- [Agent payloads](./agent-payloads.md) for the built-in payload schemas
- [Conversations](./conversations.md) for the conversation lifecycle
- [Webhook integration](./webhook-integration.md) for building the webhook backend

---

## Workflows and AI Agents

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents

Propeller supports embedded AI agents that can be triggered from the Sales Hub, Backoffice or any custom frontend. Agents connect to external workflow engines (such as n8n) via webhooks, so tenants and partners can build custom automations without modifying the core platform.

Each agent receives contextual data from the page it is embedded on (for example a complete order or quote payload) and returns a response that is displayed inline. This makes it possible to build anything from conversational sales assistants to one-click validation tools.

## How it works

An agent is a configuration object that defines where in the UI it appears, how it is triggered and which webhook processes its requests. When a user interacts with an agent, Propeller sends the page context to the configured webhook and displays the response.

The agent API is served from a separate GraphQL endpoint from the core commerce API (products, orders, pricing, users). Agent operations are not available through the standard Propeller commerce schema.

There are three main components:

1. **Agent configuration** defines the agent's identity, trigger type, UI placement and webhook endpoint
2. **Conversations** handle the request/response lifecycle between the user and the webhook
3. **Webhook integration** is the external workflow that receives context and returns responses

## Architecture

```
┌──────────────────────────────┐ ┌──────────────────────────────┐
│ Sales Hub / Backoffice       │ │ Custom Frontend              │
│                              │ │ (webshop, portal, app)       │
│ Built-in agent types:        │ │ Custom agent types:          │
│ SALES_HUB_ORDER_EDITOR       │ │ WEBSHOP_PRODUCT_DETAIL       │
│ BACKOFFICE_PRODUCTS          │ │ CUSTOMER_PORTAL_ORDERS       │
└──────────────┬───────────────┘ └───────────────┬──────────────┘
               │                                 │
               └────────────────┬────────────────┘
                                │
                                ▼
┌───────────────────────────────────────────────────────────────┐
│ Propeller Agent API (GraphQL)                                 │
│                                                               │
│ agentCreate / agents query                                    │
│ agentConversationCreate / agentMessageCreate                  │
└───────────────────────────────┬───────────────────────────────┘
                                │
                                │  POST with context payload
                                ▼
┌───────────────────────────────────────────────────────────────┐
│ External Webhook (n8n, custom API, LLM service)               │
│                                                               │
│ Receives context via requestMetadata.payload                  │
│ Returns responseMessage + optional responseMetadata           │
└───────────────────────────────────────────────────────────────┘
```

## Key concepts

- Every agent invocation includes the complete page context so external workflows do not need to make round-trip API calls to understand what the user is looking at
- The webhook is fully external. Propeller provides the trigger mechanism and context delivery. The business logic lives in the tenant's or partner's workflow engine
- Agent types are freeform strings. Implementation partners can define custom types for any page in their webshop or portal and embed agents wherever needed
- Trigger type and interaction mode are independent, giving four valid combinations. A button can open a full conversation. A chat agent can be single-turn
- Agents return both a display message and optional structured metadata, so the UI can render rich results while also feeding data into further automations
- Webhook calls support HTTP Basic Auth and HMAC-SHA256 payload signature verification. Both are optional and can be used independently or together

## Embedded agents and outbound automations

This section documents embedded agents, where Propeller calls your webhook. That is one of two directions an external workflow can take:

- **Embedded in Propeller.** The workflow waits behind a webhook and Propeller calls it when a user interacts with an agent. The response appears inline on the page.
- **Outbound automation.** The workflow runs outside Propeller on its own trigger, for example a schedule or an incoming email. It authenticates with an API key, reads or changes data through the API and pushes its results back into Propeller for follow-up, for example as sales tickets, draft orders or quote requests.

The two directions combine well. A scheduled workflow can flag a churn risk as a sales ticket, after which a sales rep opens the company page and digs deeper with an embedded agent. To create sales tickets from a workflow, see [Create sales tickets](/frontend/recipes/create-sales-tickets).

## Start from a working example

The [Workflow Hub](https://help.propeller-commerce.com/workflow-hub/) contains downloadable example workflows for both directions, each with an install guide and notes on what to adapt. Browse the [workflow library](https://help.propeller-commerce.com/workflow-hub/library/) to start from a working example instead of building from scratch.

---

## Webhook integration

URL: https://docs.propeller-commerce.com/platform/workflows-and-ai-agents/webhook-integration

The webhook URL on an agent points to an external workflow engine. Any system that can receive HTTP POST requests and return JSON responses will work. These examples use n8n but the same principles apply to any workflow engine or custom API.

## What the webhook receives

Propeller sends a POST request to the configured `webhookUrl` with the following structure.

### Headers

- `Content-Type: application/json` (always included)
- `Authorization: Basic ...` (included when basic auth credentials are configured on the agent)
- `X-Propeller-Signature: sha256=<hex-digest>` (included when a signature salt is configured on the agent)

### Body

```json
{
  "type": "SALES_HUB_ORDER_EDITOR",
  "adminUserId": 205,
  "requestMessage": "can you give me advice how to increase the order value?",
  "requestMetadata": {
    "payload": {
      "tenderId": "019d026b-99ce-7b94-b5cd-f5d436d23f78",
      "orderId": 3043,
      "status": "VALIDATED",
      "channelId": 1,
      "source": "Sales Portal",
      "contact": { "contactId": 14780, "firstName": "Wouter", "lastName": "Smrkovsky" },
      "company": { "companyId": 308, "name": "M&G Group" },
      "items": [ { "name": "La Marzocco Linea Mini – Yellow", "quantity": 1, "price": "4796.55", "costPrice": 3650, "childItems": [] } ],
      "total": { "subTotalGross": 6246.94, "totalGross": 6291.94, "totalTax": 1321.31 },
      "carriers": [ { "name": "DHL", "id": 8, "amount": 2.36 } ],
      "payMethods": [ { "code": "IDEAL", "description": "Ideal | Wero", "allowed": true } ],
      "paymentData": { "method": "", "overruled": "N", "price": 35 },
      "postageData": { "carrier": null, "overruled": "N", "price": 10 },
      "revisions": { "itemsFound": 4, "items": [] }
    }
  }
}
```

| Field | Description |
| --- | --- |
| `type` | The agent type that triggered the request (for example `SALES_HUB_ORDER_EDITOR`) |
| `adminUserId` | The backoffice user who triggered the agent |
| `requestMessage` | The user's message (present for chat agents, absent for button agents) |
| `conversationId` | Absent on the first request. Present on follow-up messages in multi-turn conversations, carrying the value your webhook returned earlier |
| `requestMetadata.payload` | The full page context. Structure varies by agent type. See [Agent payloads](./agent-payloads.md) for the complete field reference |

## What the webhook must return

The webhook responds with a JSON object. `responseMessage` is always required. For multi-turn agents `conversationId` is required too, and on the first response your webhook generates it: Propeller does not create conversation identifiers. The first request contains no `conversationId`, so your webhook mints one (any unique, non-blank string), returns it, and echoes the incoming value back on every follow-up. The structure of `responseMetadata` is entirely up to you and depends on what your workflow does.

```json
{
  "conversationId": "4308",
  "responseMessage": "The result of your workflow, displayed to the user.",
  "responseMetadata": {
    "anyKey": "anyValue"
  }
}
```

| Field | Required | Description |
| --- | --- | --- |
| `conversationId` | For multi-turn | Generated by your webhook on the first response, echoed back on follow-ups. Without it, follow-up messages cannot be linked to the conversation. Can be omitted for single-turn agents |
| `responseMessage` | Yes | Text displayed to the user in the UI |
| `responseMetadata` | No | Freeform object. Use it to pass structured data back to the UI or downstream systems. The contents are entirely defined by your workflow |

## Example: Margin Validator n8n workflow

This n8n workflow powers the Margin Validator agent. It receives quote data from Propeller, calculates the overall margin and returns an approval or warning.

### Workflow nodes

```
Webhook → Code (Process Quote Data) → Respond to Webhook
```

**1. Webhook node** listens for POST requests on the agent's webhook path. Configured with basic auth credentials matching the agent's `webhookBasicAuthUsername` and `webhookBasicAuthPassword`. Uses "response node" mode so the response is sent by a later node.

**2. Code node** contains the business logic. It extracts the quote payload from `body.requestMetadata.payload` and:

- Sums `costPrice × quantity` for all main items and their child items to get total cost
- Calculates revenue as `subTotalGross - discountGross` from the totals
- Computes margin percentage as `(revenue - totalCost) / revenue × 100`
- Compares against a 20% threshold
- Returns an approval message if the margin is at or above threshold, or a warning if below

Core logic:

```javascript
const quoteData = inputData.body?.requestMetadata?.payload || {};
const quoteItems = quoteData.items || [];

// Sum cost prices across all items including children
let totalCost = 0;
quoteItems.forEach(item => {
  totalCost += (item.costPrice || 0) * (item.quantity || 1);
  if (item.childItems) {
    item.childItems.forEach(child => {
      totalCost += (child.costPrice || 0) * (child.quantity || 1);
    });
  }
});

// Calculate margin
const totalRevenue = (quoteData.total?.subTotalGross || 0)
  - (quoteData.total?.discountGross || 0);
const marginAmount = totalRevenue - totalCost;
const marginPercentage = totalRevenue > 0
  ? (marginAmount / totalRevenue) * 100
  : 0;

const MARGIN_THRESHOLD = 20;
```

The response follows the required format. The `conversationId` is reused from the request when present and generated on the first request (only needed for multi-turn agents):

```javascript
const conversationId = inputData.body?.conversationId
  || `conv-${Date.now()}`;

return [{
  json: {
    conversationId: conversationId,
    responseMessage: responseText,
    responseMetadata: {
      processed: true,
      marginPercentage: marginPercentage.toFixed(2),
      marginAmount: marginAmount.toFixed(2),
      totalRevenue: totalRevenue.toFixed(2),
      totalCost: totalCost.toFixed(2),
      threshold: MARGIN_THRESHOLD,
      timestamp: new Date().toISOString()
    }
  }
}];
```

**3. Respond to Webhook node** sends the code node's output back to Propeller as a JSON response.

### Try it yourself

<a href="/downloads/margin-validator-n8n-workflow.json" download>Download the Margin Validator n8n workflow</a>

To get the example running:

1. In n8n, go to **Settings → Import from File** and select the downloaded JSON
2. Open the Webhook node and create a new **Basic Auth** credential with a username and password of your choice
3. Activate the workflow and copy the webhook URL that n8n generates
4. In the Propeller Backoffice, [create an agent](./agent-configuration.md#creating-an-agent) with:
   - **Webhook URL** set to the n8n webhook URL
   - **Basic auth** credentials matching what you configured in step 2
   - **Type** set to `SALES_HUB_QUOTE_EDITOR`
   - **Trigger** set to `BUTTON`
5. Open a quote in the Sales Hub and click the agent button to validate the margin

## Building your own workflow

Any workflow engine or custom API can serve as the webhook backend. The requirements are:

1. Accept a POST request with a JSON body
2. Optionally validate the `Authorization` header (Basic Auth) and/or `X-Propeller-Signature` header (HMAC-SHA256)
3. Read the context from `body.requestMetadata.payload`
4. Return a JSON response with `responseMessage` and optionally `responseMetadata`

Since the webhook is fully external, tenants and partners can build any logic they need: call LLMs, query databases, integrate with CRMs, run business rules or chain multiple steps together. The workflow can also call the Propeller API with its own API key, both to fetch data beyond the page context and to make changes, for example updating the quote the user is viewing or creating [sales tickets](/frontend/recipes/create-sales-tickets) for follow-up.

Two practical guidelines:

- **Respond quickly.** The agent panel waits for your response. For long-running work such as a full catalog scan, return a short acknowledgement and deliver the outcome asynchronously, for example as a sales ticket.
- **Keep credentials out of exports.** Workflow exports should never contain API keys. Reconnect credentials after importing and sanitize any workflow you share. Never paste an API key into an AI assistant.

For working examples you can download and adapt, browse the [Workflow Hub library](https://help.propeller-commerce.com/workflow-hub/library/).

## See also

- [Agent configuration](./agent-configuration.md) for setting up webhook credentials
- [Agent payloads](./agent-payloads.md) for the complete field reference per agent type
- [Conversations](./conversations.md) for the conversation lifecycle

---

## bundleAddItems

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/bundle-add-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use bundleAddItemsAndReturnBundle instead



Add products to an existing bundle and return the added items.

    Expands bundle contents with additional products while maintaining validation rules for unique products and single leader designation. This mutation is deprecated in favor of bundleAddItemsAndReturnBundle.

    Possible errors:
    - BUNDLE&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Bundle with the specified ID does not exist
    - BUNDLE&#x005F;ITEM&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: One or more products already exist in the bundle
    - ADD&#x005F;BUNDLE&#x005F;ITEMS&#x005F;ERROR: Failed to add items to the bundle
    - BUNDLE&#x005F;ITEMS&#x005F;NON&#x005F;UNIQUE&#x005F;ERROR: Bundle can have only one leader item
    - FORBIDDEN: Insufficient permissions to modify bundles

```graphql
bundleAddItems(
  id: String!
  input: BundleAddItemsInput!
): [BundleItem!]! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleAddItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the bundle to modify.

      Must be a valid UUID format representing an existing bundle in the system.

#### [<code style={{ fontWeight: 'normal' }}>bundleAddItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleAddItemsInput!</b></code>](/reference/graphql/inputs/bundle-add-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Items to add to the bundle.

      Contains the product configurations and roles to be added to the existing bundle.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BundleItem</b></code>](/reference/graphql/objects/bundle-item.mdx) <Badge class="badge badge--secondary " text="object"/>

Individual product item within a bundle configuration.

Represents a specific product included in a bundle with its role, pricing, and metadata. Contains information about the product's position and importance within the bundle structure.

---

## bundleRemoveItem

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/bundle-remove-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use bundleRemoveItemAndReturnBundle instead



Remove a product from an existing bundle.

    Permanently removes the specified product from the bundle configuration. This mutation is deprecated in favor of bundleRemoveItemAndReturnBundle which provides the updated bundle data.

    Possible errors:
    - BUNDLE&#x005F;ITEM&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Product is not part of the specified bundle
    - REMOVE&#x005F;BUNDLE&#x005F;ITEM&#x005F;ERROR: Failed to remove item from the bundle
    - FORBIDDEN: Insufficient permissions to modify bundles

```graphql
bundleRemoveItem(
  id: String!
  productId: Int!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleRemoveItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the bundle to modify.

      Must be a valid UUID format representing an existing bundle in the system.

#### [<code style={{ fontWeight: 'normal' }}>bundleRemoveItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product identifier to remove from the bundle.

      Must be a positive integer representing a product that exists in the specified bundle.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## carrierAssignWarehouse

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/carrier-assign-warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use `carrierAssignWarehouseAndReturnCarrier` instead.



Assign a warehouse to a carrier for shipping operations (deprecated).

    Associates a warehouse with a carrier to enable shipping services from that fulfillment location. This method is deprecated and returns only a boolean success indicator. Validates warehouse existence against the warehouse service before assignment.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;ASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to assign warehouse to carrier due to data source issues or warehouse validation failure
    - FORBIDDEN: Insufficient permissions to assign warehouses to carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierAssignWarehouse(
  id: Int!
  warehouseId: Int!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse assignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouse.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to assign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be validated against the warehouse service before assignment.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## carrierUnassignWarehouse

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/carrier-unassign-warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use `carrierUnassignWarehouseAndReturnCarrier` instead.



Remove warehouse assignment from a carrier (deprecated).

    Disassociates a warehouse from a carrier, removing shipping services from that fulfillment location. This method is deprecated and returns only a boolean success indicator.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;UNASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to unassign warehouse from carrier due to data source issues
    - FORBIDDEN: Insufficient permissions to unassign warehouses from carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierUnassignWarehouse(
  id: Int!
  warehouseId: Int!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse unassignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouse.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to unassign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be removed from the carrier's coverage areas.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## cartSetUser

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/cart-set-user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Will be removed in the future, please use `cartSetContact` or `cartSetCustomer` mutations instead.



Associate a user with an existing cart (deprecated).

    Links a user account to the cart for personalized pricing, order history, and account-specific features. This mutation is deprecated and will be removed in future versions.

    Possible errors:
    - CART&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Cart with the specified ID does not exist
    - CART&#x005F;SET&#x005F;USER&#x005F;ERROR: Failed to associate user with cart
    - USER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Specified user does not exist
    - FORBIDDEN: Insufficient permissions to modify cart

    AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
cartSetUser(
  id: String!
  input: CartSetUserInput!
): Cart! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartSetUser.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the cart to associate with user.

      Must be a valid UUID format representing an existing cart.

#### [<code style={{ fontWeight: 'normal' }}>cartSetUser.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartSetUserInput!</b></code>](/reference/graphql/inputs/cart-set-user-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

User association data.

      Contains the user identifier and any additional configuration for the user-cart association.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Cart</b></code>](/reference/graphql/objects/cart.mdx) <Badge class="badge badge--secondary " text="object"/>

Shopping cart entity for managing customer purchases.

Represents a shopping session containing products, customer information, addresses, payment preferences, and all data needed for order processing. Carts can be associated with different customer types and support various business models.

---

## companySearchCleanupOrphanedIndices

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/company-search-cleanup-orphaned-indices

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This mutation is deprecated and will be removed in a future version.



Clean up orphaned search indices from failed operations.

    Removes unused or corrupted indices that were left behind from failed reindex operations, helping maintain search infrastructure health and performance.

    Possible errors:
    - COMPANIES&#x005F;CLEANUP&#x005F;ERROR: Failed to clean up orphaned indices

```graphql
companySearchCleanupOrphanedIndices(
  input: CompanySearchReindexInput!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companySearchCleanupOrphanedIndices.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchReindexInput!</b></code>](/reference/graphql/inputs/company-search-reindex-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Cleanup configuration for identifying and removing orphaned indices.

      Specifies the criteria for identifying orphaned indices and the cleanup parameters.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## companySearchFixAliasWriteIndex

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/company-search-fix-alias-write-index

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This mutation is deprecated and will be removed in a future version.



Fix Elasticsearch alias write index configuration issues.

    Resolves problems with index aliases that prevent proper write operations to the search index. This is a maintenance operation for search infrastructure.

```graphql
companySearchFixAliasWriteIndex(
  input: CompanySearchReindexInput!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companySearchFixAliasWriteIndex.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchReindexInput!</b></code>](/reference/graphql/inputs/company-search-reindex-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Alias configuration for fixing write index issues.

      Contains the alias and index information needed to resolve write index problems.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## companySearchIndexUpdateMapping

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/company-search-index-update-mapping

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This mutation is deprecated and will be removed in a future version.



Update Elasticsearch index mapping configuration.

    Updates the search index mapping with strict settings to improve search performance and data consistency. This is a system-level operation that affects how company data is indexed and searched.

```graphql
companySearchIndexUpdateMapping(
  input: CompanySearchIndexUpdateMappingInput!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companySearchIndexUpdateMapping.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchIndexUpdateMappingInput!</b></code>](/reference/graphql/inputs/company-search-index-update-mapping-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Index mapping configuration including field definitions and search settings.

      Contains the new mapping configuration that defines how company data fields are indexed and made searchable.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## companySearchReindex

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/company-search-reindex

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This mutation is deprecated and will be removed in a future version.



Reindex company data to a new search index.

    Migrates all company data from the current index to a new index with updated configuration. This is typically used during system upgrades or when changing search index structure.

    Possible errors:
    - COMPANY&#x005F;SEARCH&#x005F;REINDEX&#x005F;ERROR: Failed to reindex company data

```graphql
companySearchReindex(
  input: CompanySearchReindexInput!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companySearchReindex.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchReindexInput!</b></code>](/reference/graphql/inputs/company-search-reindex-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Reindex configuration including source and target index settings.

      Specifies the reindexing parameters and target index configuration for the data migration process.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## logout

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/logout

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



signOut mutation will be available in the future



End user authentication session (deprecated).

    Terminates the current user session and invalidates authentication tokens. This mutation is deprecated and will be replaced by signOut mutation in future versions.

    AUTH: Role=[] OR ('user is authenticated')

```graphql
logout: Logout @deprecated
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Logout</b></code>](/reference/graphql/objects/logout.mdx) <Badge class="badge badge--secondary " text="object"/>

Response for user logout operations (deprecated).

This type is deprecated and will be replaced by a more comprehensive signOut response in future versions. Currently serves as a placeholder for logout functionality.

---

## orderUpdateAddress

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/order-update-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use orderAddressUpdate



Update an order address (deprecated - use orderAddressUpdate instead).

    Updates address information for the specified order and address ID.

    Possible errors:
    - ORDER&#x005F;ADDRESS&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Order address with specified ID does not exist for the given order
    - ORDER&#x005F;NOT&#x005F;FOUND: Order with the specified ID does not exist
    - ORDER&#x005F;ADDRESS&#x005F;UPDATE&#x005F;ERROR: Failed to update the order address due to system error
    - ORDER&#x005F;ADDRESS&#x005F;HOME&#x005F;NOT&#x005F;ALLOWED&#x005F;ERROR: Creating or updating home type addresses is not allowed
    - VALIDATION&#x005F;ERROR: Input validation failed (invalid address data, missing required fields)
    - FORBIDDEN: Insufficient permissions to update order addresses

    AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderUpdateAddress(
  id: Int!
  addressId: Int!
  input: OrderUpdateAddressInput!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID of the order this address belongs to

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>addressId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the address to update

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderUpdateAddressInput!</b></code>](/reference/graphql/inputs/order-update-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated address information

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## publishPasswordResetEmailEvent

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/publish-password-reset-email-event

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of using the triggerPasswordSendResetEmailEvent that utilizes the event-action-manager and template-engine



Send password reset email with reset link (deprecated).

    Publishes an email trigger event containing user data and password reset link for account recovery. This method is deprecated and should not be used for new implementations.

    Possible errors:
    - GET&#x005F;PASSWORD&#x005F;RESET&#x005F;LINK&#x005F;ERROR: Failed to retrieve password reset link from auth service
    - PUBSUB&#x005F;TOPIC&#x005F;PUBLISH&#x005F;FAILED&#x005F;ERROR: Failed to publish password reset email event to message queue
    - PASSWORD&#x005F;RESET&#x005F;LINK&#x005F;EMAIL&#x005F;ERROR: Unknown error occurred during password reset email processing

```graphql
publishPasswordResetEmailEvent(
  input: PasswordResetLinkEmailInput!
): PublishEmailEventResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>publishPasswordResetEmailEvent.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PasswordResetLinkEmailInput!</b></code>](/reference/graphql/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Password reset email data including user information and reset link.

      Contains user account details and generated password reset link for account recovery email.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PublishEmailEventResponse</b></code>](/reference/graphql/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Response from email event publishing operations.

Indicates the success status of email event publication to the message queue and provides tracking information for monitoring and debugging email delivery workflows.

---

## shopInvalidateCache

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/mutations/shop-invalidate-cache

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This mutation will be removed in a future version



DEPRECATED: This mutation will be removed in a future version

```graphql
shopInvalidateCache: Boolean! @deprecated
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/graphql/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## addressesByOrderId

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/addresses-by-order-id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use orderAddresses



Retrieve addresses for an order (deprecated - use orderAddresses instead).

    Returns a list of addresses associated with the specified order, optionally filtered by address type.

    Possible errors:
    - ORDER&#x005F;NOT&#x005F;FOUND: Order with the specified ID does not exist
    - ORDER&#x005F;ADDRESS&#x005F;LIST&#x005F;ERROR: Failed to retrieve order addresses due to system error
    - VALIDATION&#x005F;ERROR: Invalid order ID or address type provided
    - FORBIDDEN: Insufficient permissions to access order addresses

    AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

```graphql
addressesByOrderId(
  orderId: Int!
  type: AddressType
): [Address!]! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addressesByOrderId.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the order to retrieve addresses for

#### [<code style={{ fontWeight: 'normal' }}>addressesByOrderId.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/graphql/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Optional address type filter

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/graphql/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## companySearch

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/company-search

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This query is deprecated and will be removed in a future version.



Search and retrieve companies with comprehensive filtering and full-text search capabilities.

    Provides powerful company discovery functionality including text search across company names, addresses, and contact information. Supports advanced filtering by location, company type, status, and custom attributes with pagination and sorting.
    AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]

```graphql
companySearch(
  input: CompanySearchInput
): CompanySearchResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companySearch.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchInput</b></code>](/reference/graphql/inputs/company-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Company search criteria and filtering options.

      If not provided, returns all accessible companies with default pagination. Supports text search, location filtering, company type filtering, and advanced search options.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CompanySearchResponse</b></code>](/reference/graphql/objects/company-search-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing company search results with metadata.

Provides a structured response for company search operations including the matching companies, pagination information, and result statistics. Enables efficient browsing of large result sets with comprehensive navigation metadata.

---

## mediaDocument

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-document

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.document`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaDocument(
  mediaId: String!
): MediaDocument! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocument.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaDocument</b></code>](/reference/graphql/objects/media-document.mdx) <Badge class="badge badge--secondary " text="object"/>

Document media item with file access and metadata management capabilities

---

## mediaDocuments

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-documents

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.documents`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaDocuments(
  search: MediaDocumentSearchInput = { page: 1, offset: 12 }
): PaginatedMediaDocumentResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocuments.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentSearchInput</b></code>](/reference/graphql/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Documents search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/graphql/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing document media items with navigation metadata

---

## mediaImage

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-image

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.image`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaImage(
  mediaId: String!
): MediaImage! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImage.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the image to retrieve

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaImage</b></code>](/reference/graphql/objects/media-image.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaImages

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-images

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.images`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaImages(
  search: MediaImageSearchInput = { page: 1, offset: 12 }
): PaginatedMediaImageResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImages.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageSearchInput</b></code>](/reference/graphql/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Images search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/graphql/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing image media items with navigation metadata

---

## mediaVideo

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-video

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.video`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaVideo(
  mediaId: String!
): MediaVideo! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideo.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/graphql/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaVideo</b></code>](/reference/graphql/objects/media-video.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaVideos

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/media-videos

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.videos`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaVideos(
  search: MediaVideoSearchInput = { page: 1, offset: 12 }
): PaginatedMediaVideoResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoSearchInput</b></code>](/reference/graphql/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Videos search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/graphql/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing video media items with navigation metadata

---

## shop

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/shop

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This query will be removed in a future version



AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER] - DEPRECATED: This query will be removed in a future version

```graphql
shop(
  shopId: Int!
): Shop! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>shop.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/graphql/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Shop</b></code>](/reference/graphql/objects/shop.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## shops

URL: https://docs.propeller-commerce.com/reference/graphql/deprecated/queries/shops

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



This query will be removed in a future version



AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER] - DEPRECATED: This query will be removed in a future version

```graphql
shops: [Shop!]! @deprecated
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Shop</b></code>](/reference/graphql/objects/shop.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## Explorer

URL: https://docs.propeller-commerce.com/reference/graphql/explorer

# GraphQL Explorer

An interactive playground for testing queries and mutations against the Propeller GraphQL API. Write queries, browse the schema and see responses in real time.


The Explorer does not persist queries between sessions. Save queries and mutations you want to keep in your own environment, for example in `.graphql` files, a Postman collection or your API client of choice.


<GraphQLExplorer />

---

## GraphQL API Reference

URL: https://docs.propeller-commerce.com/reference/graphql

# GraphQL API Reference

Complete reference for the Propeller GraphQL API. Use the interactive explorer to test queries and mutations, or browse the full type system.

The GraphQL API is the primary interface for building customer-facing experiences: webshops, B2B customer portals and self-service ordering interfaces. The Storefront SDK and WordPress Plugin are both built on this API.

## In this section

- [Explorer](/reference/graphql/explorer). Interactive GraphQL playground for testing queries and mutations.
- **Queries.** All available queries.
- **Mutations.** All available mutations.
- **Objects.** Object types returned by queries and mutations.
- **Inputs.** Input types for query arguments and mutation payloads.
- **Enums.** Enumeration types.
- **Scalars.** Scalar types.
- **Interfaces.** Interface types.
- **Directives.** Directives.
- **Deprecated.** Deprecated types and fields.

Browse the full type system using the sidebar.

## Schema downloads

Download the [GraphQL schema (SDL)](https://docs.propeller-commerce.com/schema.graphql) for code generation, or introspect the endpoint directly with an API key.

---

## API Reference

URL: https://docs.propeller-commerce.com/reference

# API Reference

Technical reference for all Propeller APIs, SDKs and plugins.

All reference content covers **v2** of the APIs. Legacy v1 documentation is available separately for partners with existing v1 implementations.

| Reference | Description |
|---|---|
| [GraphQL API](/reference/graphql) | Interactive explorer, authentication, queries, mutations, types and error codes |
| [REST API](/reference/rest) | Interactive explorer, authentication, endpoints and error codes |
| [Storefront SDK](/reference/storefront-sdk) | 54 pre-built React components with properties, callbacks and usage examples |
| [Legacy APIs](/reference/legacy) | v1 GraphQL, v1 REST and REST SonarCloud for existing implementations |

## Machine-readable resources

For tooling and AI assistants:

- **OpenAPI specs (REST)**: the [OpenAPI manifest](https://docs.propeller-commerce.com/openapi/index.json) lists one spec file per service.
- **GraphQL schema**: download the [schema SDL](https://docs.propeller-commerce.com/schema.graphql), or introspect the live endpoint with an API key.
- **Documentation as Markdown**: append `.md` to any documentation URL to get its Markdown source.
- **llms.txt**: the [llms.txt index](https://docs.propeller-commerce.com/llms.txt) and the [full-text llms-full.txt](https://docs.propeller-commerce.com/llms-full.txt) for language models.

---

## _legacy-banner

URL: https://docs.propeller-commerce.com/reference/legacy/_legacy-banner

You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.

[View the current GraphQL API Reference &rarr;](/reference/graphql) | [View the current REST API Reference &rarr;](/reference/rest)

---

## carrierAssignWarehouse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/mutations/carrier-assign-warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use `carrierAssignWarehouseAndReturnCarrier` instead.



Assign a warehouse to a carrier for shipping operations (deprecated).

    Associates a warehouse with a carrier to enable shipping services from that fulfillment location. This method is deprecated and returns only a boolean success indicator. Validates warehouse existence against the warehouse service before assignment.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;ASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to assign warehouse to carrier due to data source issues or warehouse validation failure
    - FORBIDDEN: Insufficient permissions to assign warehouses to carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierAssignWarehouse(
  id: Int!
  warehouseId: Int!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse assignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouse.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to assign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be validated against the warehouse service before assignment.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## carrierUnassignWarehouse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/mutations/carrier-unassign-warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Use `carrierUnassignWarehouseAndReturnCarrier` instead.



Remove warehouse assignment from a carrier (deprecated).

    Disassociates a warehouse from a carrier, removing shipping services from that fulfillment location. This method is deprecated and returns only a boolean success indicator.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;UNASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to unassign warehouse from carrier due to data source issues
    - FORBIDDEN: Insufficient permissions to unassign warehouses from carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierUnassignWarehouse(
  id: Int!
  warehouseId: Int!
): Boolean! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse unassignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouse.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to unassign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be removed from the carrier's coverage areas.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## logout

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/mutations/logout

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



signOut mutation will be available in the future



No description

```graphql
logout(
  siteId: Int
): Logout @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>logout.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! siteId is no longer needed!

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Logout</b></code>](/reference/legacy/graphql-v1/objects/logout.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaDocument

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-document

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.document`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaDocument(
  mediaId: String!
): MediaDocument! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocument.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaDocument</b></code>](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary " text="object"/>

Document media item with file access and metadata management capabilities

---

## mediaDocuments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-documents

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.documents`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaDocuments(
  search: MediaDocumentSearchInput = { page: 1, offset: 12 }
): PaginatedMediaDocumentResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocuments.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Documents search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing document media items with navigation metadata

---

## mediaImage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-image

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.image`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaImage(
  mediaId: String!
): MediaImage! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImage.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the image to retrieve

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaImage</b></code>](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaImages

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-images

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.images`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaImages(
  search: MediaImageSearchInput = { page: 1, offset: 12 }
): PaginatedMediaImageResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImages.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Images search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing image media items with navigation metadata

---

## mediaVideo

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-video

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.video`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaVideo(
  mediaId: String!
): MediaVideo! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideo.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaVideo</b></code>](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaVideos

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/media-videos

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of `media.videos`



AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

```graphql
mediaVideos(
  search: MediaVideoSearchInput = { page: 1, offset: 12 }
): PaginatedMediaVideoResponse! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Videos search options

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing video media items with navigation metadata

---

## orderSendConfirmationEmail

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/order-send-confirmation-email

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated, use mutation instead



No description

```graphql
orderSendConfirmationEmail(
  orderId: Int!
  attachments: [Base64FileInput!]
): SendOrderConfirmResponseType! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderSendConfirmationEmail.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderSendConfirmationEmail.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Base64FileInput!]</b></code>](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SendOrderConfirmResponseType</b></code>](/reference/legacy/graphql-v1/objects/send-order-confirm-response-type.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## productAttributes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/product-attributes

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of productAttributeValues



No description

```graphql
productAttributes(
  productId: Int!
  filter: AttributeFilterInput
): [Attribute!]! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>productAttributes.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>productAttributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Attribute</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## site

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/site

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of channel



No description

```graphql
site(
  siteId: Int!
): Site! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>site.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Site</b></code>](/reference/legacy/graphql-v1/objects/site.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userAttributes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/deprecated/queries/user-attributes

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};



Deprecated in favor of userAttributeValues



No description

```graphql
userAttributes(
  userId: Int!
  filter: AttributeFilterInput
): [Attribute!]! @deprecated
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAttributes.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>userAttributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Attribute</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## deprecated

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/directives/deprecated

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Marks an element of a GraphQL schema as no longer supported.

```graphql
directive @deprecated(
  reason: String = "No longer supported"
) on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>deprecated.<b>reason</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).

---

## include

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/directives/include

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Directs the executor to include this field or fragment only when the `if` argument is true.

```graphql
directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>include.<b>if</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Included when true.

---

## oneOf

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/directives/one-of

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Indicates exactly one field must be supplied and this field must not be `null`.

```graphql
directive @oneOf on INPUT_OBJECT
```

---

## skip

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/directives/skip

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Directs the executor to skip this field or fragment when the `if` argument is true.

```graphql
directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>skip.<b>if</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Skipped when true.

---

## specifiedBy

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/directives/specified-by

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Exposes a URL that specifies the behavior of this scalar.

```graphql
directive @specifiedBy(url: String!) on SCALAR
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>specifiedBy.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The URL that specifies the behavior of this scalar.

---

## AddressType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/address-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Address types [one of 'delivery','invoice' or 'home']

```graphql
enum AddressType {
  delivery
  invoice
  home
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>AddressType.<b>delivery</b></code>](#)

Delivery address

#### [<code style={{ fontWeight: 'normal' }}>AddressType.<b>invoice</b></code>](#)

Invoice address

#### [<code style={{ fontWeight: 'normal' }}>AddressType.<b>home</b></code>](#)

Home address

### Member Of

[`Address`](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`addressesByCompanyId`](/reference/legacy/graphql-v1/queries/addresses-by-company-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByCustomerId`](/reference/legacy/graphql-v1/queries/addresses-by-customer-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByOrderId`](/reference/legacy/graphql-v1/queries/addresses-by-order-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByUserId`](/reference/legacy/graphql-v1/queries/addresses-by-user-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`CompanyAddressCreateInput`](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressCreateInput`](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressCreateInput`](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## AttributeClass

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/attribute-class

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Supported attribute classes. Objects from this enum can have attributes.

```graphql
enum AttributeClass {
  contact
  customer
  product
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>AttributeClass.<b>contact</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeClass.<b>customer</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeClass.<b>product</b></code>](#)

### Member Of

[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## AttributeType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/attribute-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

All attribute types

```graphql
enum AttributeType {
  text
  list
  enum
  enumlist
  color
  date
  datetime
  object
  integer
  decimal
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>text</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>list</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>enum</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>enumlist</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>color</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>date</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>datetime</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>object</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>integer</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>AttributeType.<b>decimal</b></code>](#)

### Member Of

[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescription`](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescriptionSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-description-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeFilterInput`](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FilterAvailableAttributeInput`](/reference/legacy/graphql-v1/inputs/filter-available-attribute-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`RangeFilterInput`](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TextFilterInput`](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeSearchInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeValueInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Auto

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/auto

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Automatic image format optimization based on browser capabilities

```graphql
enum Auto {
  WEBP
  AVIF
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Auto.<b>WEBP</b></code>](#)

Automatically convert image to WebP format when the browser supports it, providing better compression than JPEG or PNG while maintaining quality

#### [<code style={{ fontWeight: 'normal' }}>Auto.<b>AVIF</b></code>](#)

Automatically convert image to AVIF format when the browser supports it, offering superior compression compared to WebP and other formats

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BundleCondition

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/bundle-condition

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Bundle discount condition

```graphql
enum BundleCondition {
  ALL
  EP
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BundleCondition.<b>ALL</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>BundleCondition.<b>EP</b></code>](#)

### Member Of

[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CreateBundleInput`](/reference/legacy/graphql-v1/inputs/create-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IBundle`](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`UpdateBundleInput`](/reference/legacy/graphql-v1/inputs/update-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleArrayExpressionOperators

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-array-expression-operators

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Logical operators for array-based business rule expressions and collection validation

```graphql
enum BusinessRuleArrayExpressionOperators {
  all
  none
  some
  contains
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionOperators.<b>all</b></code>](#)

Check if all elements in the array meet the specified condition

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionOperators.<b>none</b></code>](#)

Check if no elements in the array meet the specified condition

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionOperators.<b>some</b></code>](#)

Check if at least one element in the array meets the specified condition

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionOperators.<b>contains</b></code>](#)

Check if the array contains a specific value or element

### Member Of

[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleArrayExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-array-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleComplexExpressionAction

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-complex-expression-action

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Aggregation functions available for complex expressions operating on filtered data collections

```graphql
enum BusinessRuleComplexExpressionAction {
  sum
  count
  collect
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionAction.<b>sum</b></code>](#)

Calculate the sum of numeric values from filtered array elements

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionAction.<b>count</b></code>](#)

Count the number of elements that match the filtering criteria

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionAction.<b>collect</b></code>](#)

Gather and return all matching elements as a collection

### Member Of

[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleDateExpressionOperators

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-date-expression-operators

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Temporal comparison operators for date and time-based business rule expressions

```graphql
enum BusinessRuleDateExpressionOperators {
  before
  after
  beforeDaysFromToday
  afterDaysFromToday
  onDaysFromToday
  beforeMinutesFromNow
  afterMinutesFromNow
  onMinutesFromNow
  onDayOfWeek
  onDayOfMonth
  onMonthOfYear
  onTime
  beforeTime
  afterTime
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>before</b></code>](#)

Check if date is before specified date value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>after</b></code>](#)

Check if date is after specified date value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>beforeDaysFromToday</b></code>](#)

Check if date is before a specified number of days from today

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>afterDaysFromToday</b></code>](#)

Check if date is after a specified number of days from today

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onDaysFromToday</b></code>](#)

Check if date matches exactly a specified number of days from today

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>beforeMinutesFromNow</b></code>](#)

Check if datetime is before a specified number of minutes from current time

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>afterMinutesFromNow</b></code>](#)

Check if datetime is after a specified number of minutes from current time

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onMinutesFromNow</b></code>](#)

Check if datetime matches exactly a specified number of minutes from current time

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onDayOfWeek</b></code>](#)

Check if date falls on a specific day of the week (1-7, Monday=1)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onDayOfMonth</b></code>](#)

Check if date falls on a specific day of the month (1-31)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onMonthOfYear</b></code>](#)

Check if date falls within a specific month of the year (1-12)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>onTime</b></code>](#)

Check if time component matches specified time value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>beforeTime</b></code>](#)

Check if time component is before specified time value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionOperators.<b>afterTime</b></code>](#)

Check if time component is after specified time value

### Member Of

[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleDecisionTableColumnType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-decision-table-column-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Defines whether a decision table column processes input conditions or generates output results

```graphql
enum BusinessRuleDecisionTableColumnType {
  input
  output
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableColumnType.<b>input</b></code>](#)

Column containing conditions and criteria that are evaluated against incoming data

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableColumnType.<b>output</b></code>](#)

Column defining the results and actions to be executed when conditions are met

### Member Of

[`BusinessRuleDecisionTableAddColumnInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-add-column-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableDeleteColumnInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-column-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleDecisionTableRowReorderDirection

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-decision-table-row-reorder-direction

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Specifies the direction for reordering decision table rows relative to a target position

```graphql
enum BusinessRuleDecisionTableRowReorderDirection {
  below
  above
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableRowReorderDirection.<b>below</b></code>](#)

Move the source row to a position below the target row

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableRowReorderDirection.<b>above</b></code>](#)

Move the source row to a position above the target row

### Member Of

[`BusinessRuleDecisionTableMoveRowInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-move-row-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleExpressionGroupOperators

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-expression-group-operators

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Logical operators for combining multiple expressions within a business rule group

```graphql
enum BusinessRuleExpressionGroupOperators {
  or
  and
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroupOperators.<b>or</b></code>](#)

Logical OR - true if any expression in the group evaluates to true

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroupOperators.<b>and</b></code>](#)

Logical AND - true only if all expressions in the group evaluate to true

### Member Of

[`BusinessRuleExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleExpressionGroupInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleSubExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleExpressionTypes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-expression-types

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Data types supported for business rule expressions and field definitions

```graphql
enum BusinessRuleExpressionTypes {
  string
  number
  boolean
  array
  complex
  date
  datetime
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>string</b></code>](#)

Text-based expressions for string matching, pattern recognition, and text operations

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>number</b></code>](#)

Numeric expressions for mathematical comparisons, calculations, and range validations

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>boolean</b></code>](#)

Boolean expressions for true/false logic and binary decision making

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>array</b></code>](#)

Array expressions for collection operations, filtering, and element validation

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>complex</b></code>](#)

Advanced expressions combining multiple sub-expressions with aggregation functions

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>date</b></code>](#)

Date-based expressions for temporal comparisons and date-specific operations

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionTypes.<b>datetime</b></code>](#)

Date and time expressions for precise temporal operations including time components

### Member Of

[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpression`](/reference/legacy/graphql-v1/objects/business-rule-string-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBusinessRuleExpression`](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## BusinessRuleHitPolicyOption

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-hit-policy-option

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Execution strategy for decision table rules when multiple conditions may match

```graphql
enum BusinessRuleHitPolicyOption {
  first
  collect
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleHitPolicyOption.<b>first</b></code>](#)

Execute only the first matching rule and stop processing subsequent rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleHitPolicyOption.<b>collect</b></code>](#)

Execute all matching rules and collect their results for comprehensive output

### Member Of

[`BusinessRuleDecisionTableContent`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-content.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableUpdateInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleNodeType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-node-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Defines the functional role of nodes within a business rule workflow graph

```graphql
enum BusinessRuleNodeType {
  inputNode
  outputNode
  decisionTableNode
  functionNode
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNodeType.<b>inputNode</b></code>](#)

Entry point node that receives and processes input data for the business rule execution

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNodeType.<b>outputNode</b></code>](#)

Terminal node that defines the final output structure and values after rule processing

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNodeType.<b>decisionTableNode</b></code>](#)

Processing node containing decision logic with conditions and actions organized in tabular format

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNodeType.<b>functionNode</b></code>](#)

Computational node that executes custom functions or complex calculations within the rule flow

### Member Of

[`BusinessRuleDecisionTable`](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleInput`](/reference/legacy/graphql-v1/objects/business-rule-input.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleOutput`](/reference/legacy/graphql-v1/objects/business-rule-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBusinessRuleNode`](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## BusinessRuleNumberExpressionOperators

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-number-expression-operators

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Mathematical comparison operators for numeric business rule expressions

```graphql
enum BusinessRuleNumberExpressionOperators {
  equals
  notEquals
  lowerThan
  greaterThan
  lowerThanOrEqualTo
  greaterThanOrEqualTo
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>equals</b></code>](#)

Exact numeric equality comparison

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>notEquals</b></code>](#)

Numeric inequality comparison

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>lowerThan</b></code>](#)

Less than comparison for numeric values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>greaterThan</b></code>](#)

Greater than comparison for numeric values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>lowerThanOrEqualTo</b></code>](#)

Less than or equal to comparison for numeric values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionOperators.<b>greaterThanOrEqualTo</b></code>](#)

Greater than or equal to comparison for numeric values

### Member Of

[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleNumberExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-number-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleStringExpressionOperators

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-string-expression-operators

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Comparison and matching operators for string-based business rule expressions

```graphql
enum BusinessRuleStringExpressionOperators {
  equals
  notEquals
  startsWith
  endsWith
  contains
  existsInArray
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>equals</b></code>](#)

Exact string match comparison (case-sensitive)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>notEquals</b></code>](#)

String inequality comparison (case-sensitive)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>startsWith</b></code>](#)

Check if string begins with specified prefix

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>endsWith</b></code>](#)

Check if string ends with specified suffix

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>contains</b></code>](#)

Check if string contains specified substring

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionOperators.<b>existsInArray</b></code>](#)

Check if string value exists within a specified array of strings

### Member Of

[`BusinessRuleStringExpression`](/reference/legacy/graphql-v1/objects/business-rule-string-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-string-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/business-rule-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Classification of business rule contexts that determine the domain and application scope for automated decision-making

```graphql
enum BusinessRuleType {
  orderPaymentMethods
  orderCarriers
  orderIncentives
  orderShippingCosts
  orderTransactionCosts
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleType.<b>orderPaymentMethods</b></code>](#)

Business rules for determining available payment methods based on order value, customer profile, and regional restrictions.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleType.<b>orderCarriers</b></code>](#)

Business rules for selecting appropriate shipping carriers based on destination, package requirements, and service levels.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleType.<b>orderIncentives</b></code>](#)

Business rules for applying promotional incentives, discounts, and special offers based on order and customer conditions.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleType.<b>orderShippingCosts</b></code>](#)

Business rules for calculating shipping costs based on order and customer conditions.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleType.<b>orderTransactionCosts</b></code>](#)

Business rules for calculating transaction costs based on order and customer conditions.

### Member Of

[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleCreateInput`](/reference/legacy/graphql-v1/inputs/business-rule-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleSearchInput`](/reference/legacy/graphql-v1/inputs/business-rule-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CacheControlType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/cache-control-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Cache Control Type [no-store, public or none]

```graphql
enum CacheControlType {
  NO_STORE
  PUBLIC
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CacheControlType.<b>NO_STORE</b></code>](#)

Adds 'no-store' to the Cache Control header

#### [<code style={{ fontWeight: 'normal' }}>CacheControlType.<b>PUBLIC</b></code>](#)

Adds 'public' to the Cache Control header

### Member Of

[`CacheControlInput`](/reference/legacy/graphql-v1/inputs/cache-control-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CarrierSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/carrier-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available fields for sorting carrier search results

```graphql
enum CarrierSortField {
  ID
  NAME
  LAST_MODIFIED_AT
  CREATED_AT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortField.<b>ID</b></code>](#)

Sort by carrier unique identifier

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortField.<b>NAME</b></code>](#)

Sort by carrier name alphabetically

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortField.<b>LAST_MODIFIED_AT</b></code>](#)

Sort by last modification date

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortField.<b>CREATED_AT</b></code>](#)

Sort by creation date

### Member Of

[`CarrierSortInput`](/reference/legacy/graphql-v1/inputs/carrier-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CarrierType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/carrier-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Classification of shipping service delivery methods

```graphql
enum CarrierType {
  PICKUP
  DELIVERY
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CarrierType.<b>PICKUP</b></code>](#)

Customer pickup service where orders are collected from designated pickup points or carrier locations

#### [<code style={{ fontWeight: 'normal' }}>CarrierType.<b>DELIVERY</b></code>](#)

Home or business delivery service where orders are delivered directly to the customer's specified address

### Member Of

[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CarrierCreateInput`](/reference/legacy/graphql-v1/inputs/carrier-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarriersSearchInput`](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarrierUpdateInput`](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CartAddressType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/cart-address-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Address types for Carts

```graphql
enum CartAddressType {
  invoice
  delivery
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CartAddressType.<b>invoice</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CartAddressType.<b>delivery</b></code>](#)

### Member Of

[`CartUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/cart-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CategorySortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/category-sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fields available for sorting categories

```graphql
enum CategorySortableFields {
  name
  dateCreated
  dateChanged
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CategorySortableFields.<b>name</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CategorySortableFields.<b>dateCreated</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CategorySortableFields.<b>dateChanged</b></code>](#)

### Member Of

[`CategorySearchInput`](/reference/legacy/graphql-v1/inputs/category-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ClusterDrillDownDisplayTypes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/cluster-drill-down-display-types

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Ways to dsplay a cluster's drilldown selection.

```graphql
enum ClusterDrillDownDisplayTypes {
  radio
  dropdown
  image
  color
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDownDisplayTypes.<b>radio</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDownDisplayTypes.<b>dropdown</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDownDisplayTypes.<b>image</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDownDisplayTypes.<b>color</b></code>](#)

### Member Of

[`ClusterDrillDown`](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IClusterDrillDown`](/reference/legacy/graphql-v1/interfaces/icluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CompanySortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/company-sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Company sortable fields

```graphql
enum CompanySortableFields {
  name
  lastModifiedDate
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CompanySortableFields.<b>name</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CompanySortableFields.<b>lastModifiedDate</b></code>](#)

### Member Of

[`CompanySortInput`](/reference/legacy/graphql-v1/inputs/company-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ContactSortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/contact-sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Contact sortable fields

```graphql
enum ContactSortableFields {
  firstName
  lastName
  lastModifiedDate
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ContactSortableFields.<b>firstName</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ContactSortableFields.<b>lastName</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ContactSortableFields.<b>lastModifiedDate</b></code>](#)

### Member Of

[`ContactSortInput`](/reference/legacy/graphql-v1/inputs/contact-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CrossupsellTypes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/crossupsell-types

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available Cross/Up Sell types

```graphql
enum CrossupsellTypes {
  ACCESSORIES
  ALTERNATIVES
  OPTIONS
  PARTS
  RELATED
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypes.<b>ACCESSORIES</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypes.<b>ALTERNATIVES</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypes.<b>OPTIONS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypes.<b>PARTS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypes.<b>RELATED</b></code>](#)

### Member Of

[`Crossupsell`](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CrossupsellInput`](/reference/legacy/graphql-v1/inputs/crossupsell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CrossupsellTypesInput`](/reference/legacy/graphql-v1/inputs/crossupsell-types-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CsvRecordErrorCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/csv-record-error-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

CsvRecordErrorCode

```graphql
enum CsvRecordErrorCode {
  VALIDATION
  DB_INSERT
  UNKNOWN
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordErrorCode.<b>VALIDATION</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordErrorCode.<b>DB_INSERT</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordErrorCode.<b>UNKNOWN</b></code>](#)

### Member Of

[`CsvRecordError`](/reference/legacy/graphql-v1/objects/csv-record-error.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CustomerSortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/customer-sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Customer sortable fields

```graphql
enum CustomerSortableFields {
  name
  lastModifiedDate
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>CustomerSortableFields.<b>name</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>CustomerSortableFields.<b>lastModifiedDate</b></code>](#)

### Member Of

[`CustomerSortInput`](/reference/legacy/graphql-v1/inputs/customer-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## DiscountType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/discount-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Discount type

```graphql
enum DiscountType {
  amount
  percentage
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>DiscountType.<b>amount</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>DiscountType.<b>percentage</b></code>](#)

### Member Of

[`TenderDiscountInput`](/reference/legacy/graphql-v1/inputs/tender-discount-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderTotal`](/reference/legacy/graphql-v1/objects/tender-total.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## DocumentFieldName

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/document-field-name

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fields available for document CSV mapping.

```graphql
enum DocumentFieldName {
  ID
  LANGUAGE
  ALT_VALUE
  DESCRIPTION_VALUE
  TAGS_VALUES
  DOCUMENT_FILE_URI
  DOCUMENT_FILE_NAME
  PRIORITY
  PRODUCT_ID
  CLUSTER_ID
  CATEGORY_ID
  SPAREPARTS_MACHINE_ID
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>ID</b></code>](#)

[Optional][String] This MediaDocument's unique identifier

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>LANGUAGE</b></code>](#)

[Required][String] Language of the MediaDocument [Default: EN]

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>ALT_VALUE</b></code>](#)

[Required][String] The alt descriptions of this MediaDocument per language

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>DESCRIPTION_VALUE</b></code>](#)

[Required][String] The descriptions of this MediaDocument per language

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>TAGS_VALUES</b></code>](#)

[Required]String[]] The tags of this MediaDocument per language

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>DOCUMENT_FILE_URI</b></code>](#)

[Required][String] MediaDocument file url

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>DOCUMENT_FILE_NAME</b></code>](#)

[Required][String] MediaDocument file name

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>PRIORITY</b></code>](#)

[Optional][Integer] MediaDocument display priority [Lower value has higher priority] - [Default: 1000]

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>PRODUCT_ID</b></code>](#)

[Optional][String] This MediaDocument's linked Product.

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>CLUSTER_ID</b></code>](#)

[Optional][String] This MediaDocument's linked Cluster

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>CATEGORY_ID</b></code>](#)

[Optional][Integer] This MediaDocument's linked Category

#### [<code style={{ fontWeight: 'normal' }}>DocumentFieldName.<b>SPAREPARTS_MACHINE_ID</b></code>](#)

[Optional][String] This MediaDocument's linked SpareParts Machine

### Member Of

[`DocumentCsvMapping`](/reference/legacy/graphql-v1/inputs/document-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## EmailEventType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/email-event-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Type of e-mail events that can be triggered

```graphql
enum EmailEventType {
  orderconfirm
  quotation
  registration
  campaign
  transactional
  custom
  system
  error
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>orderconfirm</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>quotation</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>registration</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>campaign</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>transactional</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>custom</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>system</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>EmailEventType.<b>error</b></code>](#)

### Member Of

[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## FeaturesEnableDisable

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/features-enable-disable

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Control flags for enabling or disabling specific image transformation features

```graphql
enum FeaturesEnableDisable {
  UPSCALE
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>FeaturesEnableDisable.<b>UPSCALE</b></code>](#)

Controls whether images can be enlarged beyond their original dimensions. When disabled, prevents upscaling to maintain image quality. When enabled, allows enlargement which may reduce quality but provides flexibility for responsive design.

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Fit

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/fit

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Controls how images are resized and positioned within specified dimensions while maintaining aspect ratio. Only effective when both width and height are specified.

```graphql
enum Fit {
  BOUNDS
  COVER
  CROP
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Fit.<b>BOUNDS</b></code>](#)

Scales the image to fit entirely within the specified dimensions, preserving aspect ratio. May result in letterboxing or pillarboxing if aspect ratios don't match.

#### [<code style={{ fontWeight: 'normal' }}>Fit.<b>COVER</b></code>](#)

Scales the image to completely fill the specified dimensions, preserving aspect ratio. May crop parts of the image if aspect ratios don't match.

#### [<code style={{ fontWeight: 'normal' }}>Fit.<b>CROP</b></code>](#)

Resizes and crops the image from the center to exactly match the specified dimensions, potentially removing content from edges.

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Format

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/format

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Output format for the transformed image, determining compression method, quality, and browser compatibility

```graphql
enum Format {
  AUTO
  AVIF
  BJPG
  GIF
  JPG
  JXL
  MP4
  PJPG
  PJXL
  PNG
  PNG8
  WEBP
  WEBPLL
  WEBPLY
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>AUTO</b></code>](#)

Automatically selects the optimal format based on browser capabilities, image content, and transformation requirements

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>AVIF</b></code>](#)

AV1 Image File Format - next-generation format with superior compression and quality, supported by modern browsers

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>BJPG</b></code>](#)

Baseline JPEG format optimized for broad compatibility and sequential loading

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>GIF</b></code>](#)

Graphics Interchange Format supporting animation and transparency, ideal for simple graphics and animations

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>JPG</b></code>](#)

Standard JPEG format with lossy compression, best for photographs and complex images

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>JXL</b></code>](#)

JPEG XL format offering better compression than JPEG with both lossy and lossless modes

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>MP4</b></code>](#)

MP4 video format (H.264) for converting animated images to video

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>PJPG</b></code>](#)

Progressive JPEG that loads in multiple passes, improving perceived loading speed

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>PJXL</b></code>](#)

Progressive JPEG XL that loads incrementally for better user experience

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>PNG</b></code>](#)

Portable Network Graphics with lossless compression, ideal for images with transparency or sharp edges

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>PNG8</b></code>](#)

8-bit PNG with 256-color palette and transparency, smaller file size than full PNG

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>WEBP</b></code>](#)

WebP format providing excellent compression for both lossy and lossless images

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>WEBPLL</b></code>](#)

WebP lossless format maintaining perfect image quality with better compression than PNG

#### [<code style={{ fontWeight: 'normal' }}>Format.<b>WEBPLY</b></code>](#)

WebP lossy format offering better compression than JPEG while maintaining quality

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Gender

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/gender

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

A persons gender

```graphql
enum Gender {
  M
  F
  U
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Gender.<b>M</b></code>](#)

Male

#### [<code style={{ fontWeight: 'normal' }}>Gender.<b>F</b></code>](#)

Female

#### [<code style={{ fontWeight: 'normal' }}>Gender.<b>U</b></code>](#)

Unknown

### Member Of

[`Address`](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartAddress`](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/cart-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressCreateInput`](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/company-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateContactInput`](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUserInput`](/reference/legacy/graphql-v1/inputs/create-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CustomerAddressCreateInput`](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/customer-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerInput`](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddress`](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ExternalAddressCreateInput`](/reference/legacy/graphql-v1/inputs/external-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/external-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`OrderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/order-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterContactInput`](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterCustomerInput`](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserInput`](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderAddress`](/reference/legacy/graphql-v1/objects/tender-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/tender-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateContactInput`](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCustomerInput`](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUserInput`](/reference/legacy/graphql-v1/inputs/update-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UserAddressCreateInput`](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/user-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`WarehouseAddress`](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ImageFieldName

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/image-field-name

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fields available for image CSV mapping.

```graphql
enum ImageFieldName {
  ID
  LANGUAGE
  ALT_VALUE
  DESCRIPTION_VALUE
  TAGS_VALUES
  IMAGE_FILE_URI
  IMAGE_FILE_NAME
  PRIORITY
  PRODUCT_ID
  CLUSTER_ID
  CATEGORY_ID
  SPAREPARTS_MACHINE_ID
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>ID</b></code>](#)

[Optional][String] This MediaImage's unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>LANGUAGE</b></code>](#)

[Required][String] Language of the MediaImage [Default: EN]

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>ALT_VALUE</b></code>](#)

[Required][String] The alt descriptions of this MediaImage per language

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>DESCRIPTION_VALUE</b></code>](#)

[Required][String] The descriptions of this MediaImage per language

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>TAGS_VALUES</b></code>](#)

[Required]String[]] The tags of this MediaImage per language

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>IMAGE_FILE_URI</b></code>](#)

[Required][String] MediaImage file url

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>IMAGE_FILE_NAME</b></code>](#)

[Required][String] MediaImage file name

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>PRIORITY</b></code>](#)

[Optional][Integer] MediaImage display priority [Lower value has higher priority] - [Default: 1000]

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>PRODUCT_ID</b></code>](#)

[Optional][String] This MediaImage's linked Product.

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>CLUSTER_ID</b></code>](#)

[Optional][String] This MediaImage's linked Cluster

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>CATEGORY_ID</b></code>](#)

[Optional][Integer] This MediaImage's linked Category

#### [<code style={{ fontWeight: 'normal' }}>ImageFieldName.<b>SPAREPARTS_MACHINE_ID</b></code>](#)

[Optional][String] This MediaImage's linked SpareParts Machine

### Member Of

[`ImageCsvMapping`](/reference/legacy/graphql-v1/inputs/image-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ImageMetadata

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/image-metadata

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The metadata parameters controls whether to include metadata in the output image

```graphql
enum ImageMetadata {
  COPYRIGHT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ImageMetadata.<b>COPYRIGHT</b></code>](#)

Preserve copyright notice, creator, credit line, licensor, and web statement of rights fields.

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## IncentiveActions

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/incentive-actions

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available actions that can be executed by incentive business rules to provide customer benefits and promotional offers

```graphql
enum IncentiveActions {
  ADD_PRODUCT_TO_BONUS_ITEMS
  DUPLICATE_PRODUCT_IN_BONUS_ITEMS
  MOVE_PRODUCT_TO_BONUS_ITEMS
  DUPLICATE_CHEAPEST_IN_BONUS_ITEMS
  GIVE_DISCOUNT_TO_CHEAPEST_ITEM
  GIVE_DISCOUNT_TO_ORDER_ITEM
  GIVE_DISCOUNT_TO_ORDER_TOTAL
  SET_SHIPPING_COSTS
  SET_SHIPPING_TAXCODE
  SET_TRANSACTION_COSTS
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>ADD_PRODUCT_TO_BONUS_ITEMS</b></code>](#)

Add a specific product to the order as a bonus item without charge. Used for promotional giveaways and product bundling.

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>DUPLICATE_PRODUCT_IN_BONUS_ITEMS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>MOVE_PRODUCT_TO_BONUS_ITEMS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>DUPLICATE_CHEAPEST_IN_BONUS_ITEMS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>GIVE_DISCOUNT_TO_CHEAPEST_ITEM</b></code>](#)

Apply a discount to the lowest-priced item in the order. Common for 'buy X get cheapest free' promotions.

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>GIVE_DISCOUNT_TO_ORDER_ITEM</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>GIVE_DISCOUNT_TO_ORDER_TOTAL</b></code>](#)

Apply a discount to the entire order total. Used for percentage or fixed amount discounts on the complete purchase.

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>SET_SHIPPING_COSTS</b></code>](#)

Override shipping costs with a specific amount. Used for free shipping promotions or special shipping rates.

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>SET_SHIPPING_TAXCODE</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>IncentiveActions.<b>SET_TRANSACTION_COSTS</b></code>](#)

### Member Of

[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## IncentiveDiscountType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/incentive-discount-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Calculation methods for applying discount values in incentive business rules

```graphql
enum IncentiveDiscountType {
  FlatFee
  Percentage
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>IncentiveDiscountType.<b>FlatFee</b></code>](#)

Fixed amount discount applied as an absolute monetary value

#### [<code style={{ fontWeight: 'normal' }}>IncentiveDiscountType.<b>Percentage</b></code>](#)

Proportional discount applied as a percentage of the target value

### Member Of

[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## InventoryFieldName

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/inventory-field-name

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
enum InventoryFieldName {
  LOOKUP_KEY
  INVENTORY_TYPE
  QUANTITY
  SKU
  SUPPLIER_CODE
  SUPPLIER
  PRODUCT_ID
  SOURCE_ID
  SOURCE_NAME
  LANGUAGE
  WAREHOUSE_ID
  COMPANY_ID
  COMPANY_SOURCE_ID
  COMPANY_SOURCE_NAME
  COMPANY_LANGUAGE
  USERGROUP_ID
  USERGROUP_SOURCE_ID
  USERGROUP_SOURCE_NAME
  USERGROUP_LANGUAGE
  LOCATION
  COST_PRICE
  NEXT_DELIVERY_DATE
  NOTES
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>LOOKUP_KEY</b></code>](#)

[Required][String] Key used for inventory lookup, must be one of the following: [id, sku, supplierCode, sourceId]

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>INVENTORY_TYPE</b></code>](#)

[Required][Enum] Inventory type to create, must be one of the following: [local, supplier]

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>QUANTITY</b></code>](#)

[Required][Integer] Inventory quantity

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>SKU</b></code>](#)

[Optional][String] Stock Keeping Unit identifier for the inventory, required only when lookup key is sku

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>SUPPLIER_CODE</b></code>](#)

[Optional][String] Code identifying the supplier of the inventory, required only when lookup key is supplierCode

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>SUPPLIER</b></code>](#)

[Optional][String] Inventory supplier. Defaults: - 'INTERN' for local inventory type - '[inherited from product supplier]' for supplier inventory type, required only when lookup key is supplierCode

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>PRODUCT_ID</b></code>](#)

[Required][Integer] Inventory product identifier, required only when lookup key is id

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>SOURCE_ID</b></code>](#)

[Optional][String] Identifier for the inventory source, required only when lookup key is sourceId

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>SOURCE_NAME</b></code>](#)

[Optional][String] Name of the inventory source, required only when lookup key is sourceId

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>LANGUAGE</b></code>](#)

[Optional][String] Language associated with the inventory, required only when lookup key is sourceId

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>WAREHOUSE_ID</b></code>](#)

[Optional][Integer] Inventory warehouse identifier

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>COMPANY_ID</b></code>](#)

[Optional][Integer] Company identifier related to the inventory

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>COMPANY_SOURCE_ID</b></code>](#)

[Optional][String] Source identifier for the company

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>COMPANY_SOURCE_NAME</b></code>](#)

[Optional][String] Source name for the company

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>COMPANY_LANGUAGE</b></code>](#)

[Optional][String] Language associated with the company

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>USERGROUP_ID</b></code>](#)

[Optional][Integer] Usergroup identifier related to the inventory

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>USERGROUP_SOURCE_ID</b></code>](#)

[Optional][String] Source identifier for the usergroup

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>USERGROUP_SOURCE_NAME</b></code>](#)

[Optional][String] Source name for the usergroup

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>USERGROUP_LANGUAGE</b></code>](#)

[Optional][String] Language associated with the user group

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>LOCATION</b></code>](#)

[Optional][String] Inventory location

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>COST_PRICE</b></code>](#)

[Optional][Decimal] Inventory cost price

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>NEXT_DELIVERY_DATE</b></code>](#)

[Optional][DateTime] Inventory estimated next delivery date in ISO8601 format in ISO 8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' (e.g., 2024-10-31T09:55:00.000Z)

#### [<code style={{ fontWeight: 'normal' }}>InventoryFieldName.<b>NOTES</b></code>](#)

[Optional][String] Inventory notes

### Member Of

[`InventoryCsvMapping`](/reference/legacy/graphql-v1/inputs/inventory-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## InventoryType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/inventory-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available inventory types

```graphql
enum InventoryType {
  local
  supplier
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>InventoryType.<b>local</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>InventoryType.<b>supplier</b></code>](#)

### Member Of

[`CreateInventoryInput`](/reference/legacy/graphql-v1/inputs/create-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Level

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/level

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

When converting animated GIFs to the MP4 format and when used in conjunction with the profile parameter, the level parameter specifies a set of constraints indicating a degree of required decoder performance for a profile.

NOTE: If either level or profile parameters are missing, profile=baseline&level=3.0 will be used as the default.

```graphql
enum Level {
  LEVEL_1_0
  LEVEL_1_1
  LEVEL_1_2
  LEVEL_2_0
  LEVEL_2_1
  LEVEL_2_2
  LEVEL_3_0
  LEVEL_3_1
  LEVEL_3_2
  LEVEL_4_0
  LEVEL_4_1
  LEVEL_4_2
  LEVEL_5_0
  LEVEL_5_1
  LEVEL_5_2
  LEVEL_6_0
  LEVEL_6_1
  LEVEL_6_2
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_1_0</b></code>](#)

Level: 1.0

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_1_1</b></code>](#)

Level: 1.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_1_2</b></code>](#)

Level: 1.2

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_2_0</b></code>](#)

Level: 2.0

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_2_1</b></code>](#)

Level: 2.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_2_2</b></code>](#)

Level: 2.2

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_3_0</b></code>](#)

Level: 3.0 (Default)

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_3_1</b></code>](#)

Level: 3.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_3_2</b></code>](#)

Level: 3.2

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_4_0</b></code>](#)

Level: 4.0

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_4_1</b></code>](#)

Level: 4.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_4_2</b></code>](#)

Level: 4.2

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_5_0</b></code>](#)

Level: 5.0

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_5_1</b></code>](#)

Level: 5.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_5_2</b></code>](#)

Level: 5.2

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_6_0</b></code>](#)

Level: 6.0

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_6_1</b></code>](#)

Level: 6.1

#### [<code style={{ fontWeight: 'normal' }}>Level.<b>LEVEL_6_2</b></code>](#)

Level: 6.2

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Optimize

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/optimize

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The optimize parameter automatically applies optimal quality compression to produce an output image with as much visual fidelity as possible, while minimizing the file size.

NOTE:

1. Optimize is currently supported by the following output formats: JPEG, WebP.
2. If the quality parameter is also provided, quality overrides optimize because it is more precise.
3. Because optimize attempts to produce an output image with as much visual quality as possible while minimizing the file size, the operations applied are subject to change.

```graphql
enum Optimize {
  LOW
  MEDIUM
  HIGH
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Optimize.<b>LOW</b></code>](#)

Output image quality will be similar to the input image quality.

#### [<code style={{ fontWeight: 'normal' }}>Optimize.<b>MEDIUM</b></code>](#)

More optimization is allowed. We attempt to preserve the visual quality of the input image.

#### [<code style={{ fontWeight: 'normal' }}>Optimize.<b>HIGH</b></code>](#)

Minor visual artifacts may be visible. This produces the smallest file.

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderDiscountType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-discount-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Order discount types

```graphql
enum OrderDiscountType {
  N
  P
  A
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderDiscountType.<b>N</b></code>](#)

No discount

#### [<code style={{ fontWeight: 'normal' }}>OrderDiscountType.<b>P</b></code>](#)

Percentage discount

#### [<code style={{ fontWeight: 'normal' }}>OrderDiscountType.<b>A</b></code>](#)

Absolute discount

### Member Of

[`OrderTotalInput`](/reference/legacy/graphql-v1/inputs/order-total-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderTotals`](/reference/legacy/graphql-v1/objects/order-totals.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderTotalUpdateInput`](/reference/legacy/graphql-v1/inputs/order-total-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderExportStatus

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-export-status

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available order export statuses

```graphql
enum OrderExportStatus {
  EMPTY
  EXPORTED
  FINISHED
  FAILED
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderExportStatus.<b>EMPTY</b></code>](#)

No export status available

#### [<code style={{ fontWeight: 'normal' }}>OrderExportStatus.<b>EXPORTED</b></code>](#)

Order exported

#### [<code style={{ fontWeight: 'normal' }}>OrderExportStatus.<b>FINISHED</b></code>](#)

Order finished

#### [<code style={{ fontWeight: 'normal' }}>OrderExportStatus.<b>FAILED</b></code>](#)

Order export failed

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderItemClass

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-item-class

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Class of the order item

```graphql
enum OrderItemClass {
  product
  incentive
  surcharge
  postage
  payment
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderItemClass.<b>product</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderItemClass.<b>incentive</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderItemClass.<b>surcharge</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderItemClass.<b>postage</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderItemClass.<b>payment</b></code>](#)

### Member Of

[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderSearchFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-search-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available fields to search for in an order

```graphql
enum OrderSearchFields {
  ID
  ACCOUNTING_ID
  DEBTOR_ID
  EXTERNAL_ORDER_ID
  EXTRA3
  EXTRA4
  INVOICE_ADDRESS_COMPANY
  INVOICE_ADDRESS_FIRST_NAME
  INVOICE_ADDRESS_LAST_NAME
  RECIPIENT_COMPANY
  RECIPIENT_EMAIL
  RECIPIENT_FIRST_NAME
  RECIPIENT_LAST_NAME
  REFERENCE
  REMARKS
  ITEM_EAN_CODE
  ITEM_MANUFACTURER
  ITEM_MANUFACTURER_CODE
  ITEM_NAME
  ITEM_NOTES
  ITEM_SKU
  ITEM_SUPPLIER
  ITEM_SUPPLIER_CODE
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ID</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ACCOUNTING_ID</b></code>](#)

Accounting Unique Identifier

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>DEBTOR_ID</b></code>](#)

Debtor Unique Identifier

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>EXTERNAL_ORDER_ID</b></code>](#)

External Order Unique Identifier

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>EXTRA3</b></code>](#)

Extra field 3

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>EXTRA4</b></code>](#)

Extra field 4

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>INVOICE_ADDRESS_COMPANY</b></code>](#)

Debtor Company [From Invoice Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>INVOICE_ADDRESS_FIRST_NAME</b></code>](#)

Debtor First Name [From Invoice Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>INVOICE_ADDRESS_LAST_NAME</b></code>](#)

Debtor Last Name [From Invoice Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>RECIPIENT_COMPANY</b></code>](#)

Recipient Company [From Delivery Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>RECIPIENT_EMAIL</b></code>](#)

Recipient Email [From Delivery Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>RECIPIENT_FIRST_NAME</b></code>](#)

Recipient First Name [From Delivery Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>RECIPIENT_LAST_NAME</b></code>](#)

Recipient Last Name [From Delivery Address]

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>REFERENCE</b></code>](#)

Reference

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>REMARKS</b></code>](#)

Remarks

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_EAN_CODE</b></code>](#)

Item EAN Code

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_MANUFACTURER</b></code>](#)

Item Manufacturer

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_MANUFACTURER_CODE</b></code>](#)

Item Manufacturer Code

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_NAME</b></code>](#)

Item Name

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_NOTES</b></code>](#)

Item Notes

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_SKU</b></code>](#)

Item SKU

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_SUPPLIER</b></code>](#)

Item Supplier

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchFields.<b>ITEM_SUPPLIER_CODE</b></code>](#)

Item Supplier Code

### Member Of

[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
enum OrderSortField {
  ID
  LAST_MODIFIED_AT
  CREATED_AT
  STATUS
  COMPANY
  TOTAL_GROSS
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>ID</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>LAST_MODIFIED_AT</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>CREATED_AT</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>STATUS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>COMPANY</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderSortField.<b>TOTAL_GROSS</b></code>](#)

### Member Of

[`OrderSortInput`](/reference/legacy/graphql-v1/inputs/order-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/order-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available order types

```graphql
enum OrderType {
  dropshipment
  purchase
  quotation
  stock
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderType.<b>dropshipment</b></code>](#)

Dropshipment order

#### [<code style={{ fontWeight: 'normal' }}>OrderType.<b>purchase</b></code>](#)

Purchase order

#### [<code style={{ fontWeight: 'normal' }}>OrderType.<b>quotation</b></code>](#)

Quotation order

#### [<code style={{ fontWeight: 'normal' }}>OrderType.<b>stock</b></code>](#)

Stock order

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderlistSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/orderlist-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
enum OrderlistSortField {
  ID
  DESCRIPTIONS
  LAST_MODIFIED_AT
  CREATED_AT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortField.<b>ID</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortField.<b>DESCRIPTIONS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortField.<b>LAST_MODIFIED_AT</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortField.<b>CREATED_AT</b></code>](#)

### Member Of

[`OrderlistSortInput`](/reference/legacy/graphql-v1/inputs/orderlist-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderlistType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/orderlist-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
enum OrderlistType {
  POSITIVE
  NEGATIVE
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>OrderlistType.<b>POSITIVE</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>OrderlistType.<b>NEGATIVE</b></code>](#)

### Member Of

[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderlistCreateInput`](/reference/legacy/graphql-v1/inputs/orderlist-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistSearchInput`](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistUpdateInput`](/reference/legacy/graphql-v1/inputs/orderlist-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Orient

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/orient

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The orient parameter controls the cardinal orientation of the image.

NOTE:

- By default, if the source image contains orientation information stored within its metadata, that orientation will be applied to the image data and the orientation override removed from metadata.
- The numerical values are the same as EXIF rotation numbers.

```graphql
enum Orient {
  RIGHT
  LEFT
  HORIZONTAL_FLIP
  VERTICAL_FLIP
  HV_FLIP
  ONE
  TWO
  THREE
  FOUR
  FIVE
  SIX
  SEVEN
  EIGHT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>RIGHT</b></code>](#)

Orient the image right.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>LEFT</b></code>](#)

Orient the image left.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>HORIZONTAL_FLIP</b></code>](#)

Flip the image horizontally.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>VERTICAL_FLIP</b></code>](#)

Flip the image horizontally.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>HV_FLIP</b></code>](#)

Flip the image both horizontally and vertically (also vh).

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>ONE</b></code>](#)

Default - don't do anything...

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>TWO</b></code>](#)

Flip the image horizontally.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>THREE</b></code>](#)

Flip the image horizontally and vertically.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>FOUR</b></code>](#)

Flip the image vertically.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>FIVE</b></code>](#)

Flip the image horizontally, then orient the image left (also rv or vr).

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>SIX</b></code>](#)

Orient the image right.

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>SEVEN</b></code>](#)

Flip the image horizontally, then orient the image right (also lv or vl).

#### [<code style={{ fontWeight: 'normal' }}>Orient.<b>EIGHT</b></code>](#)

Orient the image left.

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## PayMethodSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/pay-method-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available fields for sorting payment method results

```graphql
enum PayMethodSortField {
  ID
  EXTERNAL_CODE
  LAST_MODIFIED_AT
  CREATED_AT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortField.<b>ID</b></code>](#)

Sort by payment method unique identifier

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortField.<b>EXTERNAL_CODE</b></code>](#)

Sort by external system integration code

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortField.<b>LAST_MODIFIED_AT</b></code>](#)

Sort by last modification timestamp

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortField.<b>CREATED_AT</b></code>](#)

Sort by creation timestamp

### Member Of

[`PayMethodSortInput`](/reference/legacy/graphql-v1/inputs/pay-method-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## PaymentStatuses

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/payment-statuses

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Payment processing status indicating the current stage of payment lifecycle and available business actions

```graphql
enum PaymentStatuses {
  OPEN
  PENDING
  AUTHORIZED
  CANCELLED
  EXPIRED
  FAILED
  PAID
  REFUNDED
  CHARGEBACK
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>OPEN</b></code>](#)

Payment created but not yet processed by payment service provider - awaiting initial processing

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>PENDING</b></code>](#)

Payment submitted to payment service provider and awaiting processing response

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>AUTHORIZED</b></code>](#)

Payment authorized but funds not yet captured - authorization can be captured or cancelled

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>CANCELLED</b></code>](#)

Payment cancelled before completion - no funds were processed

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>EXPIRED</b></code>](#)

Payment authorization expired without capture - funds are no longer reserved

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>FAILED</b></code>](#)

Payment processing failed due to insufficient funds, declined card, or other payment issues

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>PAID</b></code>](#)

Payment successfully completed and funds captured - order can be fulfilled

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>REFUNDED</b></code>](#)

Payment refunded partially or fully to customer - funds returned to original payment method

#### [<code style={{ fontWeight: 'normal' }}>PaymentStatuses.<b>CHARGEBACK</b></code>](#)

Payment disputed and charged back by customer's financial institution - funds forcibly reversed

### Member Of

[`CreatePaymentInput`](/reference/legacy/graphql-v1/inputs/create-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UpdatePaymentInput`](/reference/legacy/graphql-v1/inputs/update-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Permission

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/permission

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permission types

```graphql
enum Permission {
  LISTFOLDER_READDATA
  READATTRIBUTES
  WRITEATTRIBUTES
  DETESUBFOLDERSANDFILES
  DELETE
  READPERMISSIONS
  CHANGEPERMISSIONS
  TAKEOWNERSHIP
  CREATEOBJECT_WRITEDATA
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>LISTFOLDER_READDATA</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>READATTRIBUTES</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>WRITEATTRIBUTES</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>DETESUBFOLDERSANDFILES</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>DELETE</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>READPERMISSIONS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>CHANGEPERMISSIONS</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>TAKEOWNERSHIP</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Permission.<b>CREATEOBJECT_WRITEDATA</b></code>](#)

### Member Of

[`userAclList`](/reference/legacy/graphql-v1/queries/user-acl-list.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## PriceMode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/price-mode

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Indicates where the price is calculated. PLATFORM - Price was calculated based on product price/postage rules set in Propeller. EXTERNAL - price is set externally

```graphql
enum PriceMode {
  PLATFORM
  EXTERNAL
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>PriceMode.<b>PLATFORM</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>PriceMode.<b>EXTERNAL</b></code>](#)

### Member Of

[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductClass

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/product-class

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available product classes

```graphql
enum ProductClass {
  product
  cluster
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ProductClass.<b>product</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductClass.<b>cluster</b></code>](#)

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ProductPriceType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/product-price-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Product price types

```graphql
enum ProductPriceType {
  default
  productDiscount
  discount
  bulk1
  bulk2
  bulk3
  bulk4
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>default</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>productDiscount</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>discount</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>bulk1</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>bulk2</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>bulk3</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductPriceType.<b>bulk4</b></code>](#)

### Member Of

[`ProductPrice`](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductStatus

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/product-status

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

All available product statuses

```graphql
enum ProductStatus {
  A
  N
  P
  S
  R
  T
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>A</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>N</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>P</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>S</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>R</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>ProductStatus.<b>T</b></code>](#)

### Member Of

[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ResizeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/resize-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The resize-filter parameter enables control over the resizing filter used to generate a new image with a higher or lower number of pixels.

NOTES: 1. When making an image smaller, use bicubic, which has a natural sharpening effect. 2. When making an image larger, use bilinear, which has a natural smoothing effect. 3. When resizing pixel art, use nearest, which has a natural pixelation effect. 4. When quality is the main concern, use lanczos, which typically renders the best results.

```graphql
enum ResizeFilter {
  NEAREST
  BILINEAR
  BICUBIC
  LANCZOS2
  LANCZOS3
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ResizeFilter.<b>NEAREST</b></code>](#)

Uses the value of nearby translated pixel values.

#### [<code style={{ fontWeight: 'normal' }}>ResizeFilter.<b>BILINEAR</b></code>](#)

Uses an average of a 2x2 environment of a pixels.

#### [<code style={{ fontWeight: 'normal' }}>ResizeFilter.<b>BICUBIC</b></code>](#)

Uses an average of a 4x4 environment of pixels, weighing the innermost pixels higher.

#### [<code style={{ fontWeight: 'normal' }}>ResizeFilter.<b>LANCZOS2</b></code>](#)

Uses the Lanczos filter to increase the ability to detect edges and linear features within an image and uses sinc resampling to provide the best possible reconstruction.

#### [<code style={{ fontWeight: 'normal' }}>ResizeFilter.<b>LANCZOS3</b></code>](#)

Lanczos3 uses a better approximation of the sinc resampling function. (Default)

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Searchablefields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/searchablefields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

All field that can be searched and boosted with the regular term input.

```graphql
enum Searchablefields {
  name
  description
  shortDescription
  keywords
  keywordsCustom
  sku
  manufacturer
  manufacturerCode
  supplier
  supplierCode
  eanCode
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>name</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>description</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>shortDescription</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>keywords</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>keywordsCustom</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>sku</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>manufacturer</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>manufacturerCode</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>supplier</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>supplierCode</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>Searchablefields.<b>eanCode</b></code>](#)

### Member Of

[`SearchFieldsInput`](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## SortOrder

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/sort-order

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Order options for sorting

```graphql
enum SortOrder {
  asc @deprecated
  desc @deprecated
  ASC
  DESC
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>ASC</b></code>](#)

Ascending order

#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>DESC</b></code>](#)

Descending order

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>asc</b></code>](#) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/>



Use ASC instead



Ascending order

#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>desc</b></code>](#) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/>



Use DESC instead



Descending order

</Details>

### Member Of

[`CarrierSortInput`](/reference/legacy/graphql-v1/inputs/carrier-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CategorySearchInput`](/reference/legacy/graphql-v1/inputs/category-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanySortInput`](/reference/legacy/graphql-v1/inputs/company-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ContactSortInput`](/reference/legacy/graphql-v1/inputs/contact-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSortInput`](/reference/legacy/graphql-v1/inputs/customer-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistSortInput`](/reference/legacy/graphql-v1/inputs/orderlist-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSortInput`](/reference/legacy/graphql-v1/inputs/order-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodSortInput`](/reference/legacy/graphql-v1/inputs/pay-method-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SortInput`](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UsergroupSortInput`](/reference/legacy/graphql-v1/inputs/usergroup-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Sort

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/sort

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sort order for search results

```graphql
enum Sort {
  ASC
  DESC
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Sort.<b>ASC</b></code>](#)

Sort results in ascending order

#### [<code style={{ fontWeight: 'normal' }}>Sort.<b>DESC</b></code>](#)

Sort results in descending order

### Member Of

[`MediaAttachmentSearchInput`](/reference/legacy/graphql-v1/inputs/media-attachment-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ObjectMediaSearchInput`](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## SortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fields available for sorting

```graphql
enum SortableFields {
  sku
  supplierCode
  dateCreated
  dateChanged
  name
  shortName
  price
  relevance
  categoryOrder
  priority
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>sku</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>supplierCode</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>dateCreated</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>dateChanged</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>name</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>shortName</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>price</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>relevance</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>categoryOrder</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>SortableFields.<b>priority</b></code>](#)

### Member Of

[`SortInput`](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TaxCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/tax-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

All supported tax codes

```graphql
enum TaxCode {
  H
  L
  N
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TaxCode.<b>H</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TaxCode.<b>L</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TaxCode.<b>N</b></code>](#)

### Member Of

[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Taxcode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/taxcode

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

All supported taxcodes

```graphql
enum Taxcode {
  H
  L
  N
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>Taxcode.<b>H</b></code>](#)

High tax rate

#### [<code style={{ fontWeight: 'normal' }}>Taxcode.<b>L</b></code>](#)

Low tax rate

#### [<code style={{ fontWeight: 'normal' }}>Taxcode.<b>N</b></code>](#)

No tax rate

### Member Of

[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartItemSurcharge`](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPaymethod`](/reference/legacy/graphql-v1/objects/cart-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartTaxLevel`](/reference/legacy/graphql-v1/objects/cart-tax-level.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItemUpdateInput`](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPaymethod`](/reference/legacy/graphql-v1/objects/tender-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderTaxLevel`](/reference/legacy/graphql-v1/objects/tender-tax-level.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderAddressType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/tender-address-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Address types for Tenders

```graphql
enum TenderAddressType {
  invoice
  delivery
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TenderAddressType.<b>invoice</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderAddressType.<b>delivery</b></code>](#)

### Member Of

[`TenderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/tender-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TenderOrderItemType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/tender-order-item-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Order item types

```graphql
enum TenderOrderItemType {
  product
  surcharge
  incentive
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderItemType.<b>product</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderItemType.<b>surcharge</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderItemType.<b>incentive</b></code>](#)

### Member Of

[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderOrderType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/tender-order-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Order types

```graphql
enum TenderOrderType {
  dropshipment
  stock
  purchase
  quotation
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderType.<b>dropshipment</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderType.<b>stock</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderType.<b>purchase</b></code>](#)

#### [<code style={{ fontWeight: 'normal' }}>TenderOrderType.<b>quotation</b></code>](#)

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderStart`](/reference/legacy/graphql-v1/inputs/tender-start.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TransactionStatuses

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/transaction-statuses

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Transaction processing status indicating the outcome of payment operations and workflow progression

```graphql
enum TransactionStatuses {
  OPEN
  PENDING
  FAILED
  SUCCESS
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TransactionStatuses.<b>OPEN</b></code>](#)

Transaction created but not yet submitted to payment service provider - awaiting processing

#### [<code style={{ fontWeight: 'normal' }}>TransactionStatuses.<b>PENDING</b></code>](#)

Transaction submitted to payment service provider and awaiting response - processing in progress

#### [<code style={{ fontWeight: 'normal' }}>TransactionStatuses.<b>FAILED</b></code>](#)

Transaction processing failed due to technical or business reasons - operation was not completed

#### [<code style={{ fontWeight: 'normal' }}>TransactionStatuses.<b>SUCCESS</b></code>](#)

Transaction completed successfully with desired outcome achieved - operation was successful

### Member Of

[`CreateTransactionInput`](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TransactionTypes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/transaction-types

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Transaction operation types representing different payment processing operations with specific business logic

```graphql
enum TransactionTypes {
  AUTHORIZATION
  CANCEL_AUTHORIZATION
  PAY
  REFUND
  CHARGEBACK
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>TransactionTypes.<b>AUTHORIZATION</b></code>](#)

Reserve funds on customer's payment method without capturing - funds are held but not transferred

#### [<code style={{ fontWeight: 'normal' }}>TransactionTypes.<b>CANCEL_AUTHORIZATION</b></code>](#)

Cancel a previously created authorization - releases reserved funds back to customer

#### [<code style={{ fontWeight: 'normal' }}>TransactionTypes.<b>PAY</b></code>](#)

Capture funds from an authorization or process direct payment - transfers money from customer to merchant

#### [<code style={{ fontWeight: 'normal' }}>TransactionTypes.<b>REFUND</b></code>](#)

Return funds to customer for a completed payment - reverses a previous payment transaction

#### [<code style={{ fontWeight: 'normal' }}>TransactionTypes.<b>CHARGEBACK</b></code>](#)

Forced reversal of payment initiated by customer's bank - dispute resolution mechanism

### Member Of

[`CreateTransactionInput`](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## UploadType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/upload-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Upload type

```graphql
enum UploadType {
  BASE64
  FILE
  URL
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>UploadType.<b>BASE64</b></code>](#)

Upload by providing base64 string representation of a file

#### [<code style={{ fontWeight: 'normal' }}>UploadType.<b>FILE</b></code>](#)

Upload by referencing a file

#### [<code style={{ fontWeight: 'normal' }}>UploadType.<b>URL</b></code>](#)

Upload by providing public url to the file

### Member Of

[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UsergroupSortableFields

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/usergroup-sortable-fields

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Usergroup sortable fields

```graphql
enum UsergroupSortableFields {
  name
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSortableFields.<b>name</b></code>](#)

### Member Of

[`UsergroupSortInput`](/reference/legacy/graphql-v1/inputs/usergroup-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetItemSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/valueset-item-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available fields for sorting value set item search results to organize dropdown options and configuration data

```graphql
enum ValuesetItemSortField {
  ID
  VALUE
  EXTRA
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSortField.<b>ID</b></code>](#)

Sort by unique identifier in numerical order, useful for consistent ordering and database optimization

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSortField.<b>VALUE</b></code>](#)

Sort alphabetically by item value, ideal for user-friendly dropdown displays and selection interfaces

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSortField.<b>EXTRA</b></code>](#)

Sort by additional metadata field, helpful for organizing items by supplementary information like codes or categories

### Member Of

[`ValuesetItemSortInput`](/reference/legacy/graphql-v1/inputs/valueset-item-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetSortField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/valueset-sort-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Available fields for sorting value set search results to organize data according to specific criteria

```graphql
enum ValuesetSortField {
  ID
  NAME
  LAST_MODIFIED_AT
  CREATED_AT
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortField.<b>ID</b></code>](#)

Sort by unique identifier in numerical order, useful for consistent ordering and database optimization

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortField.<b>NAME</b></code>](#)

Sort alphabetically by value set name, ideal for user-friendly displays and configuration interfaces

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortField.<b>LAST_MODIFIED_AT</b></code>](#)

Sort by last modification timestamp, helpful for tracking recent changes and update management

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortField.<b>CREATED_AT</b></code>](#)

Sort by creation timestamp, useful for chronological organization and audit trails

### Member Of

[`ValuesetSortInput`](/reference/legacy/graphql-v1/inputs/valueset-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetSortOrder

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/valueset-sort-order

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sort order direction for organizing search results in ascending or descending sequence

```graphql
enum ValuesetSortOrder {
  ASC
  DESC
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortOrder.<b>ASC</b></code>](#)

Ascending order - sorts from lowest to highest (A-Z, 1-9, oldest to newest)

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortOrder.<b>DESC</b></code>](#)

Descending order - sorts from highest to lowest (Z-A, 9-1, newest to oldest)

### Member Of

[`ValuesetItemSortInput`](/reference/legacy/graphql-v1/inputs/valueset-item-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetSortInput`](/reference/legacy/graphql-v1/inputs/valueset-sort-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/valueset-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Classification of value sets based on their management and usage scope within the system

```graphql
enum ValuesetType {
  SYSTEM
  CUSTOM
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>ValuesetType.<b>SYSTEM</b></code>](#)

System-managed value sets that are automatically maintained and cannot be modified by users. Used for core system functionality and predefined configurations.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetType.<b>CUSTOM</b></code>](#)

User-defined value sets that can be created, modified, and deleted by authorized users. Used for business-specific configurations and custom dropdown options.

### Member Of

[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## VideoFieldName

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/video-field-name

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fields available for video CSV mapping.

```graphql
enum VideoFieldName {
  ID
  LANGUAGE
  ALT_VALUE
  DESCRIPTION_VALUE
  TAGS_VALUES
  VIDEO_URI
  PRIORITY
  PRODUCT_ID
  CLUSTER_ID
  CATEGORY_ID
  SPAREPARTS_MACHINE_ID
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>ID</b></code>](#)

[Optional][String] This MediaVideo's unique identifier

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>LANGUAGE</b></code>](#)

[Required][String] Language of the MediaVideo [Default: EN]

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>ALT_VALUE</b></code>](#)

[Required][String] The alt descriptions of this MediaVideo per language

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>DESCRIPTION_VALUE</b></code>](#)

[Required][String] The descriptions of this MediaVideo per language

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>TAGS_VALUES</b></code>](#)

[Required]String[]] The tags of this MediaVideo per language

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>VIDEO_URI</b></code>](#)

[Required][String] MediaVideo url

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>PRIORITY</b></code>](#)

[Optional][Integer] MediaVideo display priority [Lower value has higher priority] - [Default: 1000]

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>PRODUCT_ID</b></code>](#)

[Optional][String] This MediaVideo's linked Product.

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>CLUSTER_ID</b></code>](#)

[Optional][String] This MediaVideo's linked Cluster

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>CATEGORY_ID</b></code>](#)

[Optional][Integer] This MediaVideo's linked Category

#### [<code style={{ fontWeight: 'normal' }}>VideoFieldName.<b>SPAREPARTS_MACHINE_ID</b></code>](#)

[Optional][String] This MediaVideo's linked SpareParts Machine

### Member Of

[`VideoCsvMapping`](/reference/legacy/graphql-v1/inputs/video-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## YesNo

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/enums/yes-no

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Boolean in Yes/No format

```graphql
enum YesNo {
  Y
  N
}
```

### Values

#### [<code style={{ fontWeight: 'normal' }}>YesNo.<b>Y</b></code>](#)

Affirmative response indicating true, enabled, or positive state

#### [<code style={{ fontWeight: 'normal' }}>YesNo.<b>N</b></code>](#)

Negative response indicating false, disabled, or negative state

### Member Of

[`Address`](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BundleItem`](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BundleItemInput`](/reference/legacy/graphql-v1/inputs/bundle-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartAddress`](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageDataInput`](/reference/legacy/graphql-v1/inputs/cart-postage-data-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/cart-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartVoucher`](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CompanyAddressCreateInput`](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/company-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CreateContactInput`](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUserInput`](/reference/legacy/graphql-v1/inputs/create-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CustomerAddressCreateInput`](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/customer-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerInput`](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddress`](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ExternalAddressCreateInput`](/reference/legacy/graphql-v1/inputs/external-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/external-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IBaseProduct`](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundleItem`](/reference/legacy/graphql-v1/interfaces/ibundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterOption`](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IResource`](/reference/legacy/graphql-v1/interfaces/iresource.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentData`](/reference/legacy/graphql-v1/objects/order-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPaymentInput`](/reference/legacy/graphql-v1/inputs/order-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentUpdateInput`](/reference/legacy/graphql-v1/inputs/order-payment-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageInput`](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageUpdateInput`](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/order-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`RegisterContactInput`](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterCustomerInput`](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserInput`](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderAddress`](/reference/legacy/graphql-v1/objects/tender-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/tender-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateContactInput`](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCustomerInput`](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUserInput`](/reference/legacy/graphql-v1/inputs/update-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UserAddressCreateInput`](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/user-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehouseAddress`](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## GraphQL v1 Reference

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1

# GraphQL v1 Reference

<LegacyBanner />

Complete schema reference for the Propeller GraphQL v1 API, auto-generated from the live production schema at `https://api.helice.cloud/graphql`.

Browse queries, mutations, types and enums using the sidebar. This reference is maintained for partners with existing v1 implementations. New projects should use the [GraphQL v2 API](/reference/graphql).

---

## AttributeDescriptionSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/attribute-description-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input AttributeDescriptionSearchInput {
  isSearchable: Boolean
  isPublic: Boolean
  isHidden: Boolean
  name: [String!]
  type: [AttributeType!]
  group: [String!]
  page: Int!
  offset: Int!
  class: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either searchable or not searchable.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either public or not public.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either hidden or not hidden.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

An array of attributes names you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeType!]</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

An array of attributes types you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>group</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

An array of attributes groups you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionSearchInput.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`attributeDescription`](/reference/legacy/graphql-v1/queries/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## AttributeFilterInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/attribute-filter-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input AttributeFilterInput {
  isSearchable: Boolean
  isPublic: Boolean
  isHidden: Boolean
  name: [String!]
  type: [AttributeType!]
  group: [String!]
  page: Int!
  offset: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either searchable or not searchable.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either public or not public.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only show attributes that are either hidden or not hidden.
Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

An array of attributes names you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeType!]</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

An array of attributes types you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>group</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

An array of attributes groups you want to return.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilterInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`contactAttributeValues`](/reference/legacy/graphql-v1/queries/contact-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`customerAttributeValues`](/reference/legacy/graphql-v1/queries/customer-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productAttributes`](/reference/legacy/graphql-v1/deprecated/queries/product-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productAttributeValues`](/reference/legacy/graphql-v1/queries/product-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAttributes`](/reference/legacy/graphql-v1/deprecated/queries/user-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAttributeValues`](/reference/legacy/graphql-v1/queries/user-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## AttributeValueObjectSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input AttributeValueObjectSearchInput {
  class: AttributeClass!
  type: AttributeType!
  name: String!
  textValue: LocalizedStringArrayInput
  enumValue: [String!]
  intValue: Int
  decimalValue: Float
  isSearchable: Boolean
  isPublic: Boolean
  isHidden: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeClass!</b></code>](/reference/legacy/graphql-v1/enums/attribute-class.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Object class for which the search applies to.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Attribute type.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Attribute name for which the search is applied for.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>textValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>LocalizedStringArrayInput</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Textual value(s) for the attribute, required when attribute type equals text, list or color. This value is suitable for Localization.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>enumValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Enumeration value for the attribute, required when type equals enum or enumlist. Values in this field can be multivalue.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>intValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Integer value for the attribute, required when attribute type equals numeric or object.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>decimalValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Decimal value for the attribute, required when attribute type equals decimal.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only search attributes that are either searchable or not searchable. Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only search attributes that are either public or not public. Ommmit this argument to ignore this field

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueObjectSearchInput.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only search attributes that are either hidden or not hidden. Ommmit this argument to ignore this field

### Member Of

[`attributeClassIdsByNameAndValue`](/reference/legacy/graphql-v1/queries/attribute-class-ids-by-name-and-value.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## Base64FileInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/base-64-file-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input Base64FileInput {
  base64: String!
  contentType: String!
  fileName: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Base64FileInput.<b>base64</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The base64 representation of the file contents.

#### [<code style={{ fontWeight: 'normal' }}>Base64FileInput.<b>contentType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The contentType of the base64 content.

#### [<code style={{ fontWeight: 'normal' }}>Base64FileInput.<b>fileName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indication of the fileName to use when converting the base64 to a file.

### Member Of

[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailSendEventInput`](/reference/legacy/graphql-v1/inputs/email-send-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/deprecated/queries/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/mutations/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BundleAddItemsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/bundle-add-items-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BundleAddItemsInput {
  items: [BundleItemInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BundleAddItemsInput.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BundleItemInput!]</b></code>](/reference/legacy/graphql-v1/inputs/bundle-item-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Items for this bundle.

### Member Of

[`bundleAddItems`](/reference/legacy/graphql-v1/mutations/bundle-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BundleItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/bundle-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BundleItemInput {
  productId: Int!
  isLeader: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BundleItemInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The bundles primary product identifier

#### [<code style={{ fontWeight: 'normal' }}>BundleItemInput.<b>isLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the product is leader for this bundle.

### Member Of

[`BundleAddItemsInput`](/reference/legacy/graphql-v1/inputs/bundle-add-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateBundleInput`](/reference/legacy/graphql-v1/inputs/create-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BundleSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/bundle-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BundleSearchInput {
  id: Int!
  taxZone: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BundleSearchInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Bundle identifier

#### [<code style={{ fontWeight: 'normal' }}>BundleSearchInput.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax zone

### Member Of

[`bundle`](/reference/legacy/graphql-v1/queries/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## BusinessHoursInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-hours-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessHoursInput {
  dayOfWeek: Float!
  openingTime: String
  closingTime: String
  lunchBeakStartTime: String
  lunchBeakEndTime: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessHoursInput.<b>dayOfWeek</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHoursInput.<b>openingTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHoursInput.<b>closingTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHoursInput.<b>lunchBeakStartTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHoursInput.<b>lunchBeakEndTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`CreateWarehouseInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleArrayExpressionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-array-expression-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating array-based expressions with collection operations and element validation

```graphql
input BusinessRuleArrayExpressionInput {
  operator: BusinessRuleArrayExpressionOperators!
  string: String
  number: Float
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleArrayExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-array-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Logical operator defining how the condition should be applied to array elements

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionInput.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

String value to match against array elements (used with 'contains' operator for simple value matching)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Numeric value to match against array elements (used with 'contains' operator for simple value matching)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpressionInput.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/string for options.

### Member Of

[`BusinessRuleExpressionUnionInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleComplexExpressionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating advanced expressions that combine multiple sub-expressions with aggregation functions

```graphql
input BusinessRuleComplexExpressionInput {
  operator: BusinessRuleNumberExpressionOperators!
  number: Float!
  path: String
  action: BusinessRuleComplexExpressionAction!
  field: String
  expressions: [BusinessRuleExpressionGroupInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNumberExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-number-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Mathematical comparison operator for evaluating the aggregated result against the threshold value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Numeric threshold value for comparison when using the operator (e.g., count &#x003E; 5, sum &#x003E;= 100)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/string for options.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>action</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleComplexExpressionAction!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-complex-expression-action.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Aggregation function to apply to the filtered data collection.

- 'sum': Calculate the sum of numeric values from a specific field in filtered elements
- 'count': Count the number of elements that match the filtering criteria
- 'collect': Gather and return all matching elements as a collection

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

JSONPath to the specific field for sum operations (e.g., '$.price' to sum price values from filtered elements)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpressionInput.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleExpressionGroupInput!]</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Collection of expression groups containing the filtering criteria to select elements from the data collection

### Member Of

[`BusinessRuleExpressionUnionInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input data for creating a new business rule with basic configuration and metadata

```graphql
input BusinessRuleCreateInput {
  name: [LocalizedStringInput!]!
  type: BusinessRuleType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleCreateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Localized names for the business rule supporting multiple languages for international use

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Classification of the business rule determining its domain context and application scope

### Member Of

[`businessRuleCreate`](/reference/legacy/graphql-v1/mutations/business-rule-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`incentiveRuleCreate`](/reference/legacy/graphql-v1/mutations/incentive-rule-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDateExpressionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating date and time expressions with temporal comparisons and date-specific operations

```graphql
input BusinessRuleDateExpressionInput {
  number: Int
  date: DateTime
  string: String
  operator: BusinessRuleDateExpressionOperators!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Numeric offset value for relative date calculations.

Used with operators that calculate relative dates:

- Days from today (positive for future, negative for past)
- Minutes from now for precise time calculations
- Day of week (1-7, Monday=1), day of month (1-31), month of year (1-12)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionInput.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Absolute date value for direct date comparisons (used with 'before' and 'after' operators)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionInput.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Time value in 24-hour format (HH:MM:SS) for time-based operators like 'onTime', 'beforeTime', 'afterTime'

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDateExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-date-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Temporal comparison operator defining how the date/time value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpressionInput.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/date-and-time for options.

### Member Of

[`BusinessRuleExpressionUnionInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleDecisionTableAddColumnInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-add-column-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableAddColumnInput {
  name: String!
  field: String!
  ruleId: ID!
  type: BusinessRuleDecisionTableColumnType!
  tableId: ID!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableAddColumnInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name for the input or output column

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableAddColumnInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The field of the input or output column.
In case of an input column this is the full path the root of the input payload of the rule.
In case of an output column it's the fieldname you want to output after the rule has been executed.
Output fields can be organized by using the dot notation.
For example:

- input: "input.name"
- output: "output.name.firstname"
- output: "output.name.lastname"

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableAddColumnInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule to search for

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableAddColumnInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableColumnType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-decision-table-column-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableAddColumnInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule to add the column to

### Member Of

[`businessRuleDecisionTableAddColumn`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-column.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableDeleteColumnInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-column-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableDeleteColumnInput {
  columnId: ID!
  ruleId: ID!
  type: BusinessRuleDecisionTableColumnType!
  tableId: ID!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteColumnInput.<b>columnId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the column to delete

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteColumnInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule to search for

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteColumnInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableColumnType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-decision-table-column-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the column to delete, either 'input' or 'output'

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteColumnInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule that contains the column

### Member Of

[`businessRuleDecisionTableDeleteColumn`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-column.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableDeleteRowInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-row-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableDeleteRowInput {
  rowId: ID!
  ruleId: ID!
  tableId: ID!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteRowInput.<b>rowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the row to delete

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteRowInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule that contains the row

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableDeleteRowInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule that contains the row

### Member Of

[`businessRuleDecisionTableDeleteRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableMoveRowInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-move-row-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableMoveRowInput {
  rowId: ID!
  targetRowId: ID!
  direction: BusinessRuleDecisionTableRowReorderDirection!
  ruleId: ID!
  tableId: ID!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableMoveRowInput.<b>rowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the row to move

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableMoveRowInput.<b>targetRowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the row to move to

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableMoveRowInput.<b>direction</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableRowReorderDirection!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-decision-table-row-reorder-direction.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The direction of the move action relative to the target row, either 'above' or 'below'

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableMoveRowInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule that contains the table

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableMoveRowInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule that contains the rows to move

### Member Of

[`businessRuleDecisionTableMoveRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-move-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for searching and retrieving a specific decision table from a business rule

```graphql
input BusinessRuleDecisionTableSearchInput {
  ruleId: ID!
  tableId: ID!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSearchInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the business rule containing the decision table

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSearchInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the decision table within the business rule

### Member Of

[`businessRuleDecisionTable`](/reference/legacy/graphql-v1/queries/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`businessRuleDecisionTableAddRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableSetCellInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableSetCellInput {
  ruleId: ID!
  tableId: ID!
  rowId: ID!
  columnId: ID!
  expression: BusinessRuleExpressionGroupInput
  value: String
  localizedValue: [LocalizedStringInput!]
  number: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule that contains the table cell

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule that contains the table cell

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>rowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the row the table cell

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>columnId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the column that contains the table cell

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>expression</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroupInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input.mdx) <Badge class="badge badge--secondary " text="input"/>

The expressions value for this cell

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The string value of the cell, used in output cells. Can contain a string or an expression. Strings need to be wrapped in ""

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>localizedValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The localized string value of the cell, used in output cells. Used when you want a rule to generate a translated string in the output

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableSetCellInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The numeric value for this cell, used in output cells

### Member Of

[`businessRuleDecisionTableSetCell`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-set-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleDecisionTableUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-decision-table-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input BusinessRuleDecisionTableUpdateInput {
  ruleId: ID!
  tableId: ID!
  name: String
  hitPolicy: BusinessRuleHitPolicyOption!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableUpdateInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule that contains the table to update

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableUpdateInput.<b>tableId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the DecisionTable inside BusinessRule to update

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableUpdateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The name of the table

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableUpdateInput.<b>hitPolicy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleHitPolicyOption!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-hit-policy-option.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The table's hitPolicy.
Possible values: first, collect.
'first' means that the first matching row is used.
'collect' means that all matching rows are used.

### Member Of

[`businessRuleDecisionTableUpdate`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleExpressionGroupInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating logical groups of expressions combined with AND/OR operators

```graphql
input BusinessRuleExpressionGroupInput {
  expressions: [BusinessRuleExpressionUnionInput!]!
  operator: BusinessRuleExpressionGroupOperators
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroupInput.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleExpressionUnionInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Collection of individual expressions to be combined using the specified logical operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroupInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroupOperators</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-group-operators.mdx) <Badge class="badge badge--secondary " text="enum"/>

Logical operator for combining expressions (AND requires all true, OR requires at least one true)

### Member Of

[`BusinessRuleComplexExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableSetCellInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleOrderItemSetCellInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleExpressionUnionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Expression union type that is used to list expressions inside an expression group. Each instance can contain one field

```graphql
input BusinessRuleExpressionUnionInput {
  complex: BusinessRuleComplexExpressionInput
  string: BusinessRuleStringExpressionInput
  number: BusinessRuleNumberExpressionInput
  array: BusinessRuleArrayExpressionInput
  date: BusinessRuleDateExpressionInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionUnionInput.<b>complex</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleComplexExpressionInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionUnionInput.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleStringExpressionInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-string-expression-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionUnionInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNumberExpressionInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-number-expression-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionUnionInput.<b>array</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleArrayExpressionInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-array-expression-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionUnionInput.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDateExpressionInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Member Of

[`BusinessRuleExpressionGroupInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleNumberExpressionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-number-expression-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating numeric expressions with mathematical comparisons and range validations

```graphql
input BusinessRuleNumberExpressionInput {
  operator: BusinessRuleNumberExpressionOperators!
  number: Float!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNumberExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-number-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Mathematical comparison operator defining how the numeric value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Numeric value to compare against the target field using the specified operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpressionInput.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/string for options.

### Member Of

[`BusinessRuleExpressionUnionInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria and pagination settings for filtering business rule collections

```graphql
input BusinessRuleSearchInput {
  type: [BusinessRuleType!]
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleType!]</b></code>](/reference/legacy/graphql-v1/enums/business-rule-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Filter by specific business rule types to narrow search results by domain context

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination (minimum: 1, default: 1)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page for pagination (minimum: 1, maximum: 100, default: 12)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter by creation date range to find rules created within specific time periods

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter by last modification date range to find recently updated rules

### Member Of

[`businessRules`](/reference/legacy/graphql-v1/queries/business-rules.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## BusinessRuleStringExpressionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-string-expression-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating string-based expressions with text matching and pattern recognition capabilities

```graphql
input BusinessRuleStringExpressionInput {
  operator: BusinessRuleStringExpressionOperators!
  string: String!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionInput.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleStringExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-string-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

String comparison operator defining how the string value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionInput.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text value to compare against the target field using the specified operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpressionInput.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/string for options.

### Member Of

[`BusinessRuleExpressionUnionInput`](/reference/legacy/graphql-v1/inputs/business-rule-expression-union-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## BusinessRuleUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/business-rule-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input data for updating an existing business rule's basic configuration and metadata

```graphql
input BusinessRuleUpdateInput {
  name: [LocalizedStringInput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleUpdateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated localized names for the business rule in multiple languages

### Member Of

[`businessRuleUpdate`](/reference/legacy/graphql-v1/mutations/business-rule-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CacheControlInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cache-control-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

HTTP cache control settings for media files.

Controls how browsers and CDNs cache the media content. Default settings provide optimal performance with public caching for 7 days.

```graphql
input CacheControlInput {
  type: CacheControlType
  maxAge: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CacheControlInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CacheControlType</b></code>](/reference/legacy/graphql-v1/enums/cache-control-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Cache visibility and storage policy.

    Determines whether the content can be cached by public proxies or only private caches. Defaults to 'public' for optimal CDN performance.

#### [<code style={{ fontWeight: 'normal' }}>CacheControlInput.<b>maxAge</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Maximum cache duration in seconds.

    Specifies how long browsers and CDNs should cache the media file before checking for updates. Defaults to 604800 seconds (7 days).

### Member Of

[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CanvasInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/canvas-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Change the size of the image canvas.

Sets the size of the image canvas, without changing the size of the image itself, which has the effect of adding space around the image.

This parameter takes multiple values. The first two represent the desired width and height, either as measurements of pixels, separated with a comma, or as a ratio, separated with a colon. The remaining parameters allow the placement of the image within the canvas to be adjusted. On each dimension, placement can be made either with a position coordinate (x or y, which are relative to the top left of the newly-enlarged canvas) or as a percentage offset from the center of the image using offset-x and offset-y. These can be mixed and matched, but only one method can be used for each dimension (i.e., x can be combined with offset-y but x cannot be combined with offset-x).

The remaining parameters determine the position of the cropped region.

Offset positioning acts to distribute the remaining space according to the specified offset proportions. For example, offset-y10 would place the image so that 10% of the leftover space is above the image and 90% below it.

Notes

- x and y can be set as a value in pixels (e.g., 40 is 40 pixels) or as a percentage suffixed with p (e.g., 50p is 50%).
- When x and y are percentages, they are calculated as percentages of the image size, not the canvas size.
- offset-x and offset-y are always interpreted as percentages of the canvas size (e.g., 25 is 25%).
- If no x, y, offset-x, or offset-y parameters are supplied, the image is positioned in the center of the canvas.
- The background color of the canvas will default to transparency for image output formats that support transparency and white for formats that don't. This behavior can be changed by adding the bg-color parameter.
- When using canvas and pad at the same time, pad will be ignored.
- Any fractional pixel measurements will be rounded to the nearest whole pixel.

```graphql
input CanvasInput {
  width: Int
  height: Int
  widthRatio: Int
  heightRatio: Int
  x: Int
  y: Int
  offsetX: Int
  offsetY: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>width</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Width as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>height</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Height as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>widthRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

WidthRatio as Number

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>heightRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

HeightRatio as Number

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>x</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

X as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>y</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Y as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>offsetX</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

X Offset as Percentage

#### [<code style={{ fontWeight: 'normal' }}>CanvasInput.<b>offsetY</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Y Offset as Percentage

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CarrierCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/carrier-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input data for creating a new shipping carrier.

Contains all required and optional information needed to establish a new carrier including service details, coverage areas, pricing, and integration settings.

```graphql
input CarrierCreateInput {
  name: String!
  type: CarrierType!
  descriptions: [LocalizedStringInput!]!
  trackAndTraceURL: String
  logo: String
  warehouseIds: [Int!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique name identifying the shipping carrier within your organization.

    Official name of the shipping company or service provider used for display in shipping options and logistics management.

    Validation requirements:
    - Must be unique within the organization
    - Cannot exceed 64 characters
    - Cannot be empty or contain only whitespace

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierType!</b></code>](/reference/legacy/graphql-v1/enums/carrier-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Type of shipping service offered by this carrier.

    Defines the delivery method and service characteristics provided by this carrier. Determines how customers receive their orders and affects shipping calculations.

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Localized descriptions of the carrier service for different languages and markets.

    Collection of carrier service descriptions in various languages for international shipping options and multilingual storefronts.

    Validation requirements:
    - Each description must have a unique 2-character language code (e.g., EN, DE, FR)
    - Language codes must be uppercase
    - Text values can contain up to 255 characters
    - Array must contain unique language codes only

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>trackAndTraceURL</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

URL template for package tracking and shipment monitoring.

    URL template used to generate tracking links for packages shipped with this carrier. May include placeholders for tracking numbers and other shipment details.

    Validation requirements:
    - Must be a valid HTTPS URL
    - Cannot exceed 255 characters
    - Must include protocol and host
    - Query parameters are allowed

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Public URL to the carrier's logo image for branding in shipping interfaces.

    URL pointing to the carrier's logo image used for branding in shipping options and customer-facing interfaces.

    Validation requirements:
    - Must be a valid URL
    - Cannot exceed 255 characters
    - Recommended: Maximum file size of 200kB
    - Recommended: Dimensions of 200x200px

#### [<code style={{ fontWeight: 'normal' }}>CarrierCreateInput.<b>warehouseIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifiers of warehouses where this carrier provides shipping services.

    Array of warehouse IDs that this carrier can service for shipping operations. Used to determine shipping availability and calculate shipping options based on fulfillment location.

    Validation requirements:
    - All warehouse IDs must be positive integers
    - Array must contain unique values only
    - Warehouse IDs will be validated against the warehouse service

### Member Of

[`carrierCreate`](/reference/legacy/graphql-v1/mutations/carrier-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CarrierSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/carrier-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sorting criteria for carrier result ordering.

Specifies a field and direction for sorting carrier search results. Used to control the order in which carriers are returned from search operations.

```graphql
input CarrierSortInput {
  field: CarrierSortField!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierSortField!</b></code>](/reference/legacy/graphql-v1/enums/carrier-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Field to sort carriers by.

    Specifies which carrier property to use for sorting results. Available fields include ID, name, creation date, and last modification date.

#### [<code style={{ fontWeight: 'normal' }}>CarrierSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort direction for the specified field.

    Determines whether results are sorted in ascending or descending order. Ascending order sorts from lowest to highest values, while descending sorts from highest to lowest.

### Member Of

[`CarriersSearchInput`](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CarrierUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/carrier-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input data for updating an existing shipping carrier.

Contains optional fields for modifying carrier information including service details, coverage areas, pricing, and integration settings. Only provided fields will be updated, others remain unchanged.

```graphql
input CarrierUpdateInput {
  name: String
  type: CarrierType
  descriptions: [LocalizedStringInput!]
  shippingCost: Float
  trackAndTraceURL: String
  logo: String
  warehouseIds: [Int!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique name identifying the shipping carrier within your organization.

    Official name of the shipping company or service provider used for display in shipping options and logistics management.

    Validation requirements:
    - Must be unique within the organization
    - Cannot exceed 64 characters
    - Cannot be empty or contain only whitespace

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierType</b></code>](/reference/legacy/graphql-v1/enums/carrier-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Type of shipping service offered by this carrier.

    Defines the delivery method and service characteristics provided by this carrier. Determines how customers receive their orders and affects shipping calculations.

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Localized descriptions of the carrier service for different languages and markets.

    Collection of carrier service descriptions in various languages for international shipping options and multilingual storefronts.

    Validation requirements:
    - Each description must have a unique 2-character language code (e.g., EN, DE, FR)
    - Language codes must be uppercase
    - Text values can contain up to 255 characters
    - Array must contain unique language codes only

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>shippingCost</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Base shipping cost for this carrier (deprecated).

    Fixed shipping cost associated with this carrier. This field is deprecated in favor of business rule builder for more flexible and complex pricing logic.

    Validation requirements:
    - Must be a positive decimal value
    - Supports up to 5 decimal places

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>trackAndTraceURL</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

URL template for package tracking and shipment monitoring.

    URL template used to generate tracking links for packages shipped with this carrier. May include placeholders for tracking numbers and other shipment details.

    Validation requirements:
    - Must be a valid HTTPS URL
    - Cannot exceed 255 characters
    - Must include protocol and host
    - Query parameters are allowed

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Public URL to the carrier's logo image for branding in shipping interfaces.

    URL pointing to the carrier's logo image used for branding in shipping options and customer-facing interfaces.

    Validation requirements:
    - Must be a valid URL
    - Cannot exceed 255 characters
    - Recommended: Maximum file size of 200kB
    - Recommended: Dimensions of 200x200px

#### [<code style={{ fontWeight: 'normal' }}>CarrierUpdateInput.<b>warehouseIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifiers of warehouses where this carrier provides shipping services.

    Array of warehouse IDs that this carrier can service for shipping operations. Used to determine shipping availability and calculate shipping options based on fulfillment location.

    Validation requirements:
    - All warehouse IDs must be positive integers
    - Array must contain unique values only
    - Warehouse IDs will be validated against the warehouse service

### Member Of

[`carrierUpdate`](/reference/legacy/graphql-v1/mutations/carrier-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CarriersSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/carriers-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for filtering and paginating carriers.

Provides comprehensive filtering options for carrier searches including pagination, date ranges, service types, warehouse coverage, and sorting capabilities. All filters are optional and can be combined for precise results.

```graphql
input CarriersSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  names: [String!]
  types: [CarrierType!]
  ids: [Int!]
  warehouseIds: [Int!]
  lastModifiedAt: DateSearchInput
  sortInputs: [CarrierSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination results.

    Specifies which page of results to retrieve. Used in combination with offset to control result pagination.

    Validation requirements:
    - Must be a positive integer starting from 1

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Specifies how many carriers to return per page. Used in combination with page to control result pagination.

    Validation requirements:
    - Must be a positive integer between 1 and 100

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter carriers by creation date range.

    Allows filtering carriers based on when they were created in the system.

    Validation requirements:
    - Supports both greater than and less than date comparisons
    - Dates must be in ISO 8601 format (e.g., 2024-01-15T10:30:00.000Z)

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>names</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific carrier names.

    Allows filtering carriers by their exact names. Supports multiple names for batch filtering.

    Validation requirements:
    - Names are case-sensitive and must match exactly
    - Each name cannot exceed 64 characters

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>types</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CarrierType!]</b></code>](/reference/legacy/graphql-v1/enums/carrier-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Filter by carrier service types.

    Allows filtering carriers by their service delivery methods. Supports multiple types for comprehensive filtering.

    Validation requirements:
    - Each type must be unique in the array
    - Only valid CarrierType enum values are accepted

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific carrier identifiers.

    Allows filtering carriers by their unique IDs. Supports multiple IDs for batch retrieval.

    Validation requirements:
    - Each ID must be a positive integer
    - Array must contain unique values only

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>warehouseIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter carriers by warehouse service coverage.

    Allows filtering carriers that provide services to specific warehouses. Supports multiple warehouse IDs for comprehensive coverage filtering.

    Validation requirements:
    - Each ID must be a positive integer
    - Array must contain unique values only

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter carriers by last modification date range.

    Allows filtering carriers based on when they were last updated in the system.

    Validation requirements:
    - Supports both greater than and less than date comparisons
    - Dates must be in ISO 8601 format (e.g., 2024-01-15T10:30:00.000Z)

#### [<code style={{ fontWeight: 'normal' }}>CarriersSearchInput.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CarrierSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/carrier-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Sorting criteria for result ordering.

    Allows specifying multiple sorting fields with custom ordering directions. Results are sorted in the order specified, with each sort input containing a field and direction.

    Validation requirements:
    - Each sort input must be unique
    - Field must be a valid CarrierSortField enum value
    - Order must be either ASC or DESC

### Member Of

[`carriers`](/reference/legacy/graphql-v1/queries/carriers.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CartAddBundleInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-add-bundle-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartAddBundleInput {
  cartId: String!
  quantity: Int
  notes: String
  bundleId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartAddBundleInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartAddBundleInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Quantity value for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartAddBundleInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartAddBundleInput.<b>bundleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Bundle ID of the cart item.

### Member Of

[`cartAddBundle`](/reference/legacy/graphql-v1/mutations/cart-add-bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartAddItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-add-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartAddItemInput {
  cartId: String!
  quantity: Int
  notes: String
  productId: Int!
  price: Float
  childItems: [CartChildItemInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Quantity value for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product ID of the cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cart item unit price. Defaults to calculated price. Only use for external pricing.

#### [<code style={{ fontWeight: 'normal' }}>CartAddItemInput.<b>childItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartChildItemInput!]</b></code>](/reference/legacy/graphql-v1/inputs/cart-child-item-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Adds child items to this cart item, this field is used when adding configurable clusters to the Cart.

### Member Of

[`cartAddItem`](/reference/legacy/graphql-v1/mutations/cart-add-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartChildItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-child-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartChildItemInput {
  productId: Int!
  price: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartChildItemInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product ID of the child item.

#### [<code style={{ fontWeight: 'normal' }}>CartChildItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cart item unit price. Defaults to calculated price. Only use for external pricing.

### Member Of

[`CartAddItemInput`](/reference/legacy/graphql-v1/inputs/cart-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CartDeleteItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-delete-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartDeleteItemInput {
  cartId: String!
  itemId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartDeleteItemInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartDeleteItemInput.<b>itemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart item identifier.

### Member Of

[`cartDeleteItem`](/reference/legacy/graphql-v1/mutations/cart-delete-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartPaymentDataInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-payment-data-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartPaymentDataInput {
  method: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentDataInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected paymethod for this cart. Defaults to REKENING.

### Member Of

[`CartUpdateInput`](/reference/legacy/graphql-v1/inputs/cart-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CartPostageDataInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-postage-data-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartPostageDataInput {
  shippingMethod: String
  requestDate: DateTime
  partialDeliveryAllowed: YesNo
  postage: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartPostageDataInput.<b>shippingMethod</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected shipping method for this cart. Defaults to VERZENDEN.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageDataInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageDataInput.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Is partial delivery allowed for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageDataInput.<b>postage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Postage cost excluding VAT based on external postage calculation. If value is set, postage priceMode is set to 'EXTERNAL' for this cart.

### Member Of

[`CartUpdateInput`](/reference/legacy/graphql-v1/inputs/cart-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CartProcessInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-process-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartProcessInput {
  cartId: String!
  orderStatus: String!
  language: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartProcessInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartProcessInput.<b>orderStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order status for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartProcessInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language of the order. Defaults to user's primary language

### Member Of

[`cartProcess`](/reference/legacy/graphql-v1/mutations/cart-process.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartSetUserInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-set-user-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartSetUserInput {
  cartId: String!
  userId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartSetUserInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartSetUserInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User identifier for this cart.

### Member Of

[`cartSetUser`](/reference/legacy/graphql-v1/mutations/cart-set-user.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartUpdateAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-update-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartUpdateAddressInput {
  cartId: String!
  type: CartAddressType!
  company: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String
  code: String
  email: String
  mobile: String
  phone: String
  url: String
  icp: YesNo
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddressType!</b></code>](/reference/legacy/graphql-v1/enums/cart-address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company name.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Gender.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

First name.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Middle name.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Last name.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Street.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

House number.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

House number extension.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Postal code.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

City.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Region.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Country.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email address.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Mobile phone number.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Phone number.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Url.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Marks wether this address an ICP address.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateAddressInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's address notes.

### Member Of

[`cartUpdateAddress`](/reference/legacy/graphql-v1/mutations/cart-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartUpdateInput {
  cartId: String!
  paymentData: CartPaymentDataInput
  postageData: CartPostageDataInput
  notes: String
  reference: String
  extra3: String
  extra4: String
  carrier: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPaymentDataInput</b></code>](/reference/legacy/graphql-v1/inputs/cart-payment-data-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Payment data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPostageDataInput</b></code>](/reference/legacy/graphql-v1/inputs/cart-postage-data-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Postage data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's notes for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's reference for this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateInput.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this cart.

### Member Of

[`cartUpdate`](/reference/legacy/graphql-v1/mutations/cart-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartUpdateItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-update-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartUpdateItemInput {
  cartId: String!
  quantity: Int
  notes: String
  itemId: Int!
  price: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart identifier for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Quantity value for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemInput.<b>itemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart item identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cart item unit price. Defaults to calculated price. Only use for external pricing.

### Member Of

[`cartUpdateItem`](/reference/legacy/graphql-v1/mutations/cart-update-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartUpdateItemsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/cart-update-items-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CartUpdateItemsInput {
  quantity: Int
  notes: String
  itemId: Int!
  price: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemsInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Quantity value for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemsInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemsInput.<b>itemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cart item identifier.

#### [<code style={{ fontWeight: 'normal' }}>CartUpdateItemsInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cart item unit price. Defaults to calculated price. Only use for external pricing.

### Member Of

[`cartUpdateItems`](/reference/legacy/graphql-v1/mutations/cart-update-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CategorySearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/category-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CategorySearchInput {
  name: String
  language: String
  slug: [String!]
  categoryId: [Int!]
  parentCategoryId: [Int!]
  page: Int
  offset: Int
  sortField: CategorySortableFields
  sortOrder: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Find categories by name

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The language to use when searching categories by name or slug. When omitted the categories default language is used

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Find categories by one or more slugs

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Find categories by one or more categoryIds

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>parentCategoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Find categories by one or more parentCategoryIds

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The page number to return

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The amount of categories return per page

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>sortField</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CategorySortableFields</b></code>](/reference/legacy/graphql-v1/enums/category-sortable-fields.mdx) <Badge class="badge badge--secondary " text="enum"/>

Available sortable fields One of: [name, dateCreated, entityDateChanged]

#### [<code style={{ fontWeight: 'normal' }}>CategorySearchInput.<b>sortOrder</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort ordering ['desc' or 'asc']

### Member Of

[`categories`](/reference/legacy/graphql-v1/queries/categories.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CompanyAddressCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/company-address-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CompanyAddressCreateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  companyId: Int!
  type: AddressType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address company primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType!</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type [one of 'home', 'delivery' or 'invoice']

### Member Of

[`companyAddressCreate`](/reference/legacy/graphql-v1/mutations/company-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CompanyAddressDeleteInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/company-address-delete-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CompanyAddressDeleteInput {
  id: Int!
  companyId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressDeleteInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressDeleteInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Company primary identifier

### Member Of

[`companyAddressDelete`](/reference/legacy/graphql-v1/mutations/company-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CompanyAddressUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/company-address-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CompanyAddressUpdateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  companyId: Int!
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address company primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CompanyAddressUpdateInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`companyAddressUpdate`](/reference/legacy/graphql-v1/mutations/company-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CompanySearchArguments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/company-search-arguments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CompanySearchArguments {
  companyIds: [Int!]
  usergroupId: Int
  name: String
  managedCompaniesOnly: Boolean
  page: Int!
  offset: Int!
  sort: [CompanySortInput!]
  lastModifiedDate: DateSearchInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique company ids

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>usergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company's name

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>managedCompaniesOnly</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

When true, only companies managed by the viewer will be listed

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CompanySortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/company-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sort filters

#### [<code style={{ fontWeight: 'normal' }}>CompanySearchArguments.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

### Member Of

[`companies`](/reference/legacy/graphql-v1/queries/companies.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CompanySortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/company-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CompanySortInput {
  field: CompanySortableFields!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompanySortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySortableFields!</b></code>](/reference/legacy/graphql-v1/enums/company-sortable-fields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Available sortable fields

#### [<code style={{ fontWeight: 'normal' }}>CompanySortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort ordering ['desc' or 'asc']

### Member Of

[`CompanySearchArguments`](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ContactSearchArguments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/contact-search-arguments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ContactSearchArguments {
  contactIds: [Int!]
  firstName: String
  middleName: String
  lastName: String
  email: String
  gender: Gender
  attribute: UserManagementAttributeSearchInput
  page: Int!
  offset: Int!
  sort: [ContactSortInput!]
  lastModifiedDate: DateSearchInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>contactIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique contact ids

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Contact's first name

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Contact's middle name

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Contact's last name

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Contact's email

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Contact's gender

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>attribute</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UserManagementAttributeSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by Customer's attributes

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ContactSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/contact-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of contact sort filters

#### [<code style={{ fontWeight: 'normal' }}>ContactSearchArguments.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

### Member Of

[`contacts`](/reference/legacy/graphql-v1/queries/contacts.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ContactSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/contact-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ContactSortInput {
  field: ContactSortableFields!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ContactSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ContactSortableFields!</b></code>](/reference/legacy/graphql-v1/enums/contact-sortable-fields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Available contact sortable fields

#### [<code style={{ fontWeight: 'normal' }}>ContactSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort contact ordering ['desc' or 'asc']

### Member Of

[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CreateAuthenticationInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-authentication-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateAuthenticationInput {
  email: String!
  password: String
  phoneNumber: String
  displayName: String
  uid: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateAuthenticationInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateAuthenticationInput.<b>password</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateAuthenticationInput.<b>phoneNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateAuthenticationInput.<b>displayName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateAuthenticationInput.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`authenticationCreate`](/reference/legacy/graphql-v1/mutations/authentication-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateBundleInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-bundle-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateBundleInput {
  name: String!
  description: String!
  discount: Float
  condition: BundleCondition
  price: Float
  taxZone: String
  addBundleItems: [BundleItemInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The description for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage this bundle.

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>condition</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleCondition</b></code>](/reference/legacy/graphql-v1/enums/bundle-condition.mdx) <Badge class="badge badge--secondary " text="enum"/>

The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL).

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The bundle prices.

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The bundle tax zone.

#### [<code style={{ fontWeight: 'normal' }}>CreateBundleInput.<b>addBundleItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BundleItemInput!]</b></code>](/reference/legacy/graphql-v1/inputs/bundle-item-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Items for this bundle.

### Member Of

[`bundleCreate`](/reference/legacy/graphql-v1/mutations/bundle-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateCategoryInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-category-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateCategoryInput {
  name: [LocalizedStringInput!]!
  description: [LocalizedStringInput!]!
  shortDescription: [LocalizedStringInput!]!
  parent: Int
  defaultLanguage: String!
  metadataTitle: [LocalizedStringInput!]
  metadataDescription: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrl: [LocalizedStringInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Localized category name as it is available in
the supported language defaults to the category's default language.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

The long description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

The long description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>parent</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The category's parent Category when available

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata title in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata description in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata keywords in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateCategoryInput.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata canonical urls in different languages.

### Member Of

[`categoryCreate`](/reference/legacy/graphql-v1/mutations/category-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateCompanyInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-company-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateCompanyInput {
  name: String
  taxNumber: String
  cocNumber: String
  email: String
  phone: String
  notes: String
  parentId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateCompanyInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the company should be created in.

### Member Of

[`companyCreate`](/reference/legacy/graphql-v1/mutations/company-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateContactInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-contact-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateContactInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  homepage: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the company the contact should be created in.

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the contact.

#### [<code style={{ fontWeight: 'normal' }}>CreateContactInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Contacts's custom attribute values. This field is used to set value on attributes for the selected contact. Attributes that are used here (selected by name) must already be defined in Propeller.

### Member Of

[`contactCreate`](/reference/legacy/graphql-v1/mutations/contact-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateInventoryInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-inventory-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateInventoryInput {
  type: InventoryType!
  productId: Int!
  quantity: Int!
  location: String
  warehouseId: Int
  notes: String
  nextDeliveryDate: String
  costPrice: Float
  supplier: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>InventoryType!</b></code>](/reference/legacy/graphql-v1/enums/inventory-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Inventory type to create

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory product identifier

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory quantity

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>location</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory location

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory warehouse identifier

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory notes

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>nextDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory estimated next delivery date in ISO8601 format

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory cost price

#### [<code style={{ fontWeight: 'normal' }}>CreateInventoryInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory supplier. Defaults: - 'INTERN' for local inventory type - '[inherited from product supplier]' for supplier inventory type

### Member Of

[`inventoryCreate`](/reference/legacy/graphql-v1/mutations/inventory-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateOrUpdateOrderItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-or-update-order-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateOrUpdateOrderItemInput {
  update: OrderItemUpdateInput
  create: OrderItemCreateInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateOrUpdateOrderItemInput.<b>update</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemUpdateInput</b></code>](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary " text="input"/>

OrderItem update payload

#### [<code style={{ fontWeight: 'normal' }}>CreateOrUpdateOrderItemInput.<b>create</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemCreateInput</b></code>](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary " text="input"/>

OrderItem create payload

### Member Of

[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CreatePaymentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-payment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Payment creation data including transaction details and payment method information.

Contains all necessary information to create a payment record including amounts, payment method, and optional transaction data. All monetary amounts must be expressed in the smallest currency unit (cents) for precision.

```graphql
input CreatePaymentInput {
  userId: Int
  anonymousId: Int
  paymentId: String
  orderId: Int!
  amount: Int!
  currency: String!
  method: String!
  status: PaymentStatuses!
  addTransaction: CreateTransactionInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Authenticated user identifier for payment attribution and history tracking.

Links the payment to a specific authenticated user for user-specific payment history and account management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>anonymousId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Anonymous user session identifier for guest checkout payments.

References the guest user session for payments made without authentication. Used for guest checkout tracking and order management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment identifier provided by the payment service provider for tracking.

Unique payment reference provided by the Payment Service Provider (PSP) for tracking and reconciliation. Used for payment status updates and transaction matching. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order identifier that this payment is intended to fulfill.

References the specific order that this payment is intended to fulfill. Used for order-payment relationship tracking and fulfillment processing. Must be a positive integer.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment amount in smallest currency unit (cents) for precise financial calculations.

The total amount to be paid expressed in the smallest denomination of the currency (e.g., cents for USD, pence for GBP). Must be a positive integer for precise financial calculations.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ISO 4217 three-letter currency code for international financial transactions.

Three-letter currency code (e.g., USD, EUR, GBP) following ISO 4217 standard. Used for currency conversion and financial reporting. Must be exactly 3 uppercase letters.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method code used by the payment service provider for transaction processing.

Specific payment method code used by the Payment Service Provider for processing this transaction (e.g., 'credit_card', 'paypal', 'bank_transfer'). Maximum length of 100 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaymentStatuses!</b></code>](/reference/legacy/graphql-v1/enums/payment-statuses.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Initial payment processing status for the new payment record.

Sets the starting status for the payment lifecycle. Determines the initial state and available actions for the payment processing workflow.

#### [<code style={{ fontWeight: 'normal' }}>CreatePaymentInput.<b>addTransaction</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateTransactionInput</b></code>](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Optional transaction to create alongside the payment for immediate processing.

When provided, creates an associated transaction record with the payment for immediate processing and tracking. Enables atomic creation of payment and initial transaction in a single operation.

### Member Of

[`paymentCreate`](/reference/legacy/graphql-v1/mutations/payment-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateProductInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-product-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateProductInput {
  language: String!
  categoryId: Int
  name: [LocalizedStringInput!]
  description: [LocalizedStringInput!]
  shortDescription: [LocalizedStringInput!]
  sku: String
  status: ProductStatus
  supplier: String
  supplierCode: String
  manufacturerCode: String
  eanCode: String
  taxCode: TaxCode
  originalPrice: Float
  unit: Int
  minimumQuantity: Int
  manufacturer: String
  costPrice: Float
  suggestedPrice: Float
  package: String
  shortName: String
  packageDescription: [LocalizedStringInput!]
  notes: [LocalizedStringInput!]
  priority: Int
  metadataTitle: [LocalizedStringInput!]
  metadataDescription: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrl: [LocalizedStringInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The language of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the category the product should be created in.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The names of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The short descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The sku of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductStatus</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="enum"/>

The status of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier code of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer (OEM) code of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The EAN code of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TaxCode</b></code>](/reference/legacy/graphql-v1/enums/tax-code.mdx) <Badge class="badge badge--secondary " text="enum"/>

The tax code of the product. Defaults to H.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original price of the product

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unit. Defaults to 1.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product minimum quantity. Defaults to 1.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer of the product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product cost price

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>suggestedPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product suggested price

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The default package type for this product.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>shortName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The short name product.
Commonly used for connections with third parties that
have a size limitation on the product name field.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>packageDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The package type descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Notes of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata title in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata description in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata keywords in different languages.

#### [<code style={{ fontWeight: 'normal' }}>CreateProductInput.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata canonical urls in different languages.

### Member Of

[`productCreate`](/reference/legacy/graphql-v1/mutations/product-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateSparePartInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-spare-part-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateSparePartInput {
  name: [LocalizedStringInput!]
  quantity: Int!
  sku: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Spare PartsMachine name

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartInput.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`CreateSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpsertSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CreateSparePartsMachineInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateSparePartsMachineInput {
  externalReference: ExternalReferenceInput!
  name: [LocalizedStringInput!]!
  description: [LocalizedStringInput!]
  machines: [CreateSparePartsMachineInput!]
  parts: [CreateSparePartInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartsMachineInput.<b>externalReference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExternalReferenceInput!</b></code>](/reference/legacy/graphql-v1/inputs/external-reference-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartsMachineInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Spare PartsMachine name

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartsMachineInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Machine description

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartsMachineInput.<b>machines</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CreateSparePartsMachineInput!]</b></code>](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Level 1 SubMachines input

#### [<code style={{ fontWeight: 'normal' }}>CreateSparePartsMachineInput.<b>parts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CreateSparePartInput!]</b></code>](/reference/legacy/graphql-v1/inputs/create-spare-part-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Spare parts for this machine

### Member Of

[`CreateSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`machineCreate`](/reference/legacy/graphql-v1/mutations/machine-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`UpsertSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CreateTaxInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-tax-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateTaxInput {
  shopId: Int
  code: String
  zone: String!
  ratio: Float
  exportCode: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateTaxInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shop identifier for the tax to apply to... If not provided the default will be inferred from the channel

#### [<code style={{ fontWeight: 'normal' }}>CreateTaxInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax code

#### [<code style={{ fontWeight: 'normal' }}>CreateTaxInput.<b>zone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tax zone

#### [<code style={{ fontWeight: 'normal' }}>CreateTaxInput.<b>ratio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax percentage expressed as ratio

#### [<code style={{ fontWeight: 'normal' }}>CreateTaxInput.<b>exportCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax export code

### Member Of

[`taxCreate`](/reference/legacy/graphql-v1/mutations/tax-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateTransactionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-transaction-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Transaction creation data including operation type, amount, and processing details.

Contains all necessary information to create a transaction record including transaction type, amounts, currency, and processing status. All monetary amounts must be expressed in the smallest currency unit (cents) for precision.

```graphql
input CreateTransactionInput {
  transactionId: String!
  paymentId: String
  amount: Int!
  currency: String!
  description: String
  timestamp: DateTime
  type: TransactionTypes!
  provider: String
  status: TransactionStatuses!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>transactionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

External transaction identifier provided by the payment service provider for tracking.

Unique transaction reference provided by the Payment Service Provider (PSP) for tracking and reconciliation. Used for transaction status updates and matching with external systems. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment identifier provided by the payment service provider for correlation.

External payment identifier provided by the Payment Service Provider for correlation with parent payment. Used to link transactions to their originating payments in external systems. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Transaction amount in smallest currency unit (cents) for precise financial calculations.

The transaction amount expressed in the smallest denomination of the currency (e.g., cents for USD, pence for GBP). Must be a positive integer for precise financial calculations.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ISO 4217 three-letter currency code for international financial transactions.

Three-letter currency code (e.g., USD, EUR, GBP) following ISO 4217 standard. Used for currency conversion and financial reporting. Must be exactly 3 uppercase letters.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Human-readable description of the transaction purpose or details.

Optional descriptive text explaining the transaction purpose or providing additional context for record keeping and audit trails. Maximum length of 500 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>timestamp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the transaction was processed by the payment service provider.

ISO 8601 formatted timestamp indicating when the transaction was processed by the external payment service provider. Used for transaction sequencing and audit trails.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransactionTypes!</b></code>](/reference/legacy/graphql-v1/enums/transaction-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Type of transaction operation to be performed.

Specifies the specific payment operation to execute (authorization, capture, refund, etc.). Each type has distinct business logic and financial implications for the payment workflow.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>provider</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Name of the payment service provider processing the transaction.

Identifies the external payment service provider handling the transaction processing. Used for provider-specific logic and reporting. Maximum length of 100 characters.

#### [<code style={{ fontWeight: 'normal' }}>CreateTransactionInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransactionStatuses!</b></code>](/reference/legacy/graphql-v1/enums/transaction-statuses.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Initial processing status for the new transaction.

Sets the starting status for the transaction processing workflow. Determines the initial state and available actions for the transaction lifecycle management.

### Member Of

[`CreatePaymentInput`](/reference/legacy/graphql-v1/inputs/create-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdatePaymentInput`](/reference/legacy/graphql-v1/inputs/update-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CreateUserInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-user-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateUserInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  email: String
  homepage: String
  taxNumber: String
  cocNumber: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the user should be created in.

#### [<code style={{ fontWeight: 'normal' }}>CreateUserInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user.

### Member Of

[`userCreate`](/reference/legacy/graphql-v1/mutations/user-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateUsergroupInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-usergroup-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateUsergroupInput {
  name: String
  parentId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateUsergroupInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CreateUsergroupInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the company should be created in.

### Member Of

[`usergroupCreate`](/reference/legacy/graphql-v1/mutations/usergroup-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateWarehouseAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-warehouse-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateWarehouseAddressInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseAddressInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

### Member Of

[`CreateWarehouseInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`warehouseAddressCreate`](/reference/legacy/graphql-v1/mutations/warehouse-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CreateWarehouseInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/create-warehouse-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CreateWarehouseInput {
  name: String!
  description: String!
  notes: String!
  isActive: Boolean!
  isStore: Boolean!
  isPickupLocation: Boolean!
  shopId: Int
  businessHours: [BusinessHoursInput!]!
  createWarehouseAddress: CreateWarehouseAddressInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse name

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse description

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse notes

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>isActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isActive status

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>isStore</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isStore status

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>isPickupLocation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isPickupLocation status

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optional warehouse shopId! Default value will be internally inferred from the appropriate channel

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>businessHours</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessHoursInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/business-hours-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Warehouse business hours per week day

    Example:
        [&#x007B;
          dayOfWeek: 0
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 1
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 2
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 3
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 4
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 5
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 6
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;]

#### [<code style={{ fontWeight: 'normal' }}>CreateWarehouseInput.<b>createWarehouseAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateWarehouseAddressInput</b></code>](/reference/legacy/graphql-v1/inputs/create-warehouse-address-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Add a address related to the specified warehouse

### Member Of

[`warehouseCreate`](/reference/legacy/graphql-v1/mutations/warehouse-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CropInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/crop-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Removes pixels from an image.

When specifying a crop parameter, the value starts with the desired width and height, either as measurements of pixels, separated with a comma, or as a ratio, separated with a colon (for example, crop=4:3 or crop=640,480 or crop=0.8,0.4).

The remaining parameters determine the position of the cropped region. On each dimension, placement can be made either with a position coordinate (x or y, which are relative to the top left of the uncropped image) or as a percentage offset from the center of the image using offset-x and offset-y. These can be mixed and matched, but only one method can be used for each dimension (i.e., x can be combined with offset-y but x cannot be combined with offset-x).

Offset positioning acts to distribute the remaining space according to the specified offset proportions. If an image is 2000 pixels wide and is being cropped to 1000 pixels wide, offset-x10 would crop 10% (100 pixels) from the left of the image and 90% (900 pixels) from the right. An offset of 50 centers the crop in the middle of the image.

Appending ,smart to the parameter value enables content-aware algorithms to attempt to crop the image to the desired aspect ratio while intelligently focusing on the most important visual content, including the detection of faces.

If the specified cropped region is outside the bounds of the image, the transformation will fail with the error "Invalid transformation for requested image: Invalid crop, region out of bounds". Append ,safe to the parameter value to override this. In safe mode, the image gets delivered as an intersection of the origin image and the specified cropped region. This avoids the error, but the resulting image may not be of the specified dimensions.

```graphql
input CropInput {
  width: Int
  height: Int
  widthRatio: Int
  heightRatio: Int
  x: Int
  y: Int
  offsetX: Int
  offsetY: Int
  smart: String
  safe: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>width</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Width as Pixel or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>height</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Height as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>widthRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

WidthRatio as Number

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>heightRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

HeightRatio as Number

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>x</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

X coordinate as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>y</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Y coordinate as Pixels or Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>offsetX</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

X coordinate offset as Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>offsetY</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Y coordinate offset as Percentage

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>smart</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

smart

#### [<code style={{ fontWeight: 'normal' }}>CropInput.<b>safe</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

safe

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## CrossupsellInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/crossupsell-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CrossupsellInput {
  types: [CrossupsellTypes!]
  subTypes: [String!]
  productId: Int
  clusterId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellInput.<b>types</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CrossupsellTypes!]</b></code>](/reference/legacy/graphql-v1/enums/crossupsell-types.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Crossupsell types

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellInput.<b>subTypes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Crossupsell subtypes

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cross/Up Sell product identifier

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cross/Up Sell cluster identifier

### Member Of

[`crossupsells`](/reference/legacy/graphql-v1/queries/crossupsells.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CrossupsellTypesInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/crossupsell-types-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CrossupsellTypesInput {
  types: [CrossupsellTypes!]
  subTypes: [String!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypesInput.<b>types</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CrossupsellTypes!]</b></code>](/reference/legacy/graphql-v1/enums/crossupsell-types.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Crossupsell types

#### [<code style={{ fontWeight: 'normal' }}>CrossupsellTypesInput.<b>subTypes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Crossupsell subtypes

---

## CustomerAddressCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-address-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerAddressCreateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  customerId: Int!
  type: AddressType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address customer primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType!</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type [one of 'home', 'delivery' or 'invoice']

### Member Of

[`customerAddressCreate`](/reference/legacy/graphql-v1/mutations/customer-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CustomerAddressDeleteInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-address-delete-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerAddressDeleteInput {
  id: Int!
  customerId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressDeleteInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressDeleteInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer primary identifier

### Member Of

[`customerAddressDelete`](/reference/legacy/graphql-v1/mutations/customer-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CustomerAddressUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-address-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerAddressUpdateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  customerId: Int!
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address customer primary identifier

#### [<code style={{ fontWeight: 'normal' }}>CustomerAddressUpdateInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`customerAddressUpdate`](/reference/legacy/graphql-v1/mutations/customer-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CustomerInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerInput {
  customerId: Int
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the customer should be created in.

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the customer.

#### [<code style={{ fontWeight: 'normal' }}>CustomerInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Customer's custom attribute values. This field is used to set value on attributes for the selected customer. Attributes that are used here (selected by name) must already be defined in Propeller.

### Member Of

[`customerCreate`](/reference/legacy/graphql-v1/mutations/customer-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CustomerSearchArguments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-search-arguments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerSearchArguments {
  customerIds: [Int!]
  firstName: String
  middleName: String
  lastName: String
  email: String
  gender: Gender
  attribute: UserManagementAttributeSearchInput
  page: Int
  offset: Int
  sort: [CustomerSortInput!]
  lastModifiedDate: DateSearchInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>customerIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique customer ids

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's first name

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's middle name

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's last name

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Customer's email

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Customer's gender

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>attribute</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UserManagementAttributeSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by Customer's attributes

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CustomerSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/customer-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of customer sort filters

#### [<code style={{ fontWeight: 'normal' }}>CustomerSearchArguments.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

### Member Of

[`customers`](/reference/legacy/graphql-v1/queries/customers.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CustomerSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/customer-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input CustomerSortInput {
  field: CustomerSortableFields!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerSortableFields!</b></code>](/reference/legacy/graphql-v1/enums/customer-sortable-fields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Available customer sortable fields

#### [<code style={{ fontWeight: 'normal' }}>CustomerSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort customer ordering ['desc' or 'asc']

### Member Of

[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## DateSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/date-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input DateSearchInput {
  greaterThan: String
  lessThan: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DateSearchInput.<b>greaterThan</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date greater than provided date

#### [<code style={{ fontWeight: 'normal' }}>DateSearchInput.<b>lessThan</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date less than provided date

### Member Of

[`BusinessRuleSearchInput`](/reference/legacy/graphql-v1/inputs/business-rule-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarriersSearchInput`](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanySearchArguments`](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistSearchInput`](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodSearchInput`](/reference/legacy/graphql-v1/inputs/pay-method-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## DecimalSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/decimal-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input DecimalSearchInput {
  greaterThan: Float
  lessThan: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DecimalSearchInput.<b>greaterThan</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

greater than or equal

#### [<code style={{ fontWeight: 'normal' }}>DecimalSearchInput.<b>lessThan</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

less than or equal

### Member Of

[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## DeleteWarehouseAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/delete-warehouse-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input DeleteWarehouseAddressInput {
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DeleteWarehouseAddressInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`warehouseAddressDelete`](/reference/legacy/graphql-v1/mutations/warehouse-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## DocumentCsvInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/document-csv-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input DocumentCsvInput {
  file: Upload!
  mappings: [DocumentCsvMapping!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DocumentCsvInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Upload!</b></code>](/reference/legacy/graphql-v1/scalars/upload.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

CSV file

#### [<code style={{ fontWeight: 'normal' }}>DocumentCsvInput.<b>mappings</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[DocumentCsvMapping!]</b></code>](/reference/legacy/graphql-v1/inputs/document-csv-mapping.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

A list of MediaDocuments CSV field mappings

### Member Of

[`mediaDocumentCsvImport`](/reference/legacy/graphql-v1/mutations/media-document-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## DocumentCsvMapping

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/document-csv-mapping

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input DocumentCsvMapping {
  csvHeader: String!
  fieldName: DocumentFieldName!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DocumentCsvMapping.<b>csvHeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the column in the CSV file

#### [<code style={{ fontWeight: 'normal' }}>DocumentCsvMapping.<b>fieldName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DocumentFieldName!</b></code>](/reference/legacy/graphql-v1/enums/document-field-name.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The name of the field in Propeller eCommerce Platform

### Member Of

[`DocumentCsvInput`](/reference/legacy/graphql-v1/inputs/document-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## EmailEventInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/email-event-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input EmailEventInput {
  type: EmailEventType!
  siteId: Int
  orderId: Int
  userId: Int
  letterId: String
  subject: String
  content: String
  from: EmailSendContactInput
  to: [EmailSendContactInput!]
  attachments: [Base64FileInput!]
  variables: JSONObject
  language: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailEventType!</b></code>](/reference/legacy/graphql-v1/enums/email-event-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of email event to trigger

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the site to use when sending the email, required when the site can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the order to use when triggering an event of type orderconfirm

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the user to send to email to. Can be used to replace to, when the user can't be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>letterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the Propeller letter to use when type is 'campaign'

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>subject</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The subject of the email, use when the subject can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>content</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The content of the email, use when the content can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailSendContactInput</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary " text="input"/>

The sender of the email, use when the sender can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>to</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[EmailSendContactInput!]</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The recipient(s) of the email, use when the recipient(s) can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Base64FileInput!]</b></code>](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Attachments to add to the email

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>variables</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Variables that can be used in the email template

#### [<code style={{ fontWeight: 'normal' }}>EmailEventInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The language of the generated email

### Member Of

[`publishEmailEvent`](/reference/legacy/graphql-v1/mutations/publish-email-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## EmailSendContactInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/email-send-contact-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input EmailSendContactInput {
  email: String!
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>EmailSendContactInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email address of the contact

#### [<code style={{ fontWeight: 'normal' }}>EmailSendContactInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The name of the contact

### Member Of

[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailSendEventInput`](/reference/legacy/graphql-v1/inputs/email-send-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## EmailSendEventInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/email-send-event-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input EmailSendEventInput {
  subject: String!
  content: String!
  from: EmailSendContactInput!
  to: [EmailSendContactInput!]!
  cc: [EmailSendContactInput!]
  bcc: [EmailSendContactInput!]
  attachments: [Base64FileInput!]
  campaignId: String
  messageId: String
  utmTags: String
  variables: JSONObject
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>subject</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The subject of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>content</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The content of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailSendContactInput!</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

The sender of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>to</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[EmailSendContactInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

The recipient(s) of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>cc</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[EmailSendContactInput!]</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The cc recipient(s) of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>bcc</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[EmailSendContactInput!]</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The bcc recipient(s) of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Base64FileInput!]</b></code>](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The attachment(s) of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>campaignId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The campaingId of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>messageId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The messageId of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>utmTags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The utmTags of the email

#### [<code style={{ fontWeight: 'normal' }}>EmailSendEventInput.<b>variables</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Variables that can be used in the email template

### Member Of

[`publishEmailSendEvent`](/reference/legacy/graphql-v1/mutations/publish-email-send-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ExchangeRefreshTokenInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/exchange-refresh-token-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ExchangeRefreshTokenInput {
  refreshToken: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExchangeRefreshTokenInput.<b>refreshToken</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`exchangeRefreshToken`](/reference/legacy/graphql-v1/mutations/exchange-refresh-token.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ExternalAddressCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/external-address-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ExternalAddressCreateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  icp: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressCreateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

### Member Of

[`externalAddressCreate`](/reference/legacy/graphql-v1/mutations/external-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ExternalAddressDeleteInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/external-address-delete-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ExternalAddressDeleteInput {
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressDeleteInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`externalAddressDelete`](/reference/legacy/graphql-v1/mutations/external-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ExternalAddressUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/external-address-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ExternalAddressUpdateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  icp: YesNo
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddressUpdateInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`externalAddressUpdate`](/reference/legacy/graphql-v1/mutations/external-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ExternalReferenceInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/external-reference-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ExternalReferenceInput {
  source: String!
  sourceId: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExternalReferenceInput.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ExternalReferenceInput.<b>sourceId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`CreateSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpsertSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## FavoriteListsBaseSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FavoriteListsBaseSearchInput {
  name: String
  isDefault: Boolean
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsBaseSearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List name

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsBaseSearchInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List is default

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsBaseSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List page

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsBaseSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List offset

---

## FavoriteListsCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/favorite-lists-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FavoriteListsCreateInput {
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  isDefault: Boolean
  name: String!
  companyId: Int
  companySource: SourceInput
  contactId: Int
  contactSource: SourceInput
  customerId: Int
  customerSource: SourceInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List product IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List cluster IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List is default

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List name

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List company ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>companySource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A company source

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List contact ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>contactSource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A contact source

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List customer ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsCreateInput.<b>customerSource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A customer source

### Member Of

[`favoriteListCreate`](/reference/legacy/graphql-v1/mutations/favorite-list-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## FavoriteListsItemsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/favorite-lists-items-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FavoriteListsItemsInput {
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsItemsInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List product IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsItemsInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsItemsInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List cluster IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsItemsInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

### Member Of

[`favoriteListAddItems`](/reference/legacy/graphql-v1/mutations/favorite-list-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListRemoveItems`](/reference/legacy/graphql-v1/mutations/favorite-list-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## FavoriteListsSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/favorite-lists-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FavoriteListsSearchInput {
  name: String
  isDefault: Boolean
  page: Int
  offset: Int
  companyId: Int
  companySource: SourceInput
  contactId: Int
  contactSource: SourceInput
  customerId: Int
  customerSource: SourceInput
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List name

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List is default

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List page

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List offset

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List company ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>companySource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A company source

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List contact ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>contactSource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A contact source

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List customer ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>customerSource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A customer source

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product ids

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of cluster ids

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date created

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

### Member Of

[`favoriteLists`](/reference/legacy/graphql-v1/queries/favorite-lists.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## FavoriteListsUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/favorite-lists-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FavoriteListsUpdateInput {
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  isDefault: Boolean
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List product IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List cluster IDs list

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List is default

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsUpdateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List name

### Member Of

[`favoriteListUpdate`](/reference/legacy/graphql-v1/mutations/favorite-list-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## FilterAvailableAttributeInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/filter-available-attribute-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input FilterAvailableAttributeInput {
  isPublic: Boolean
  isSearchable: Boolean
  id: [String!]
  searchId: [String!]
  type: [AttributeType!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FilterAvailableAttributeInput.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>FilterAvailableAttributeInput.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>FilterAvailableAttributeInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>FilterAvailableAttributeInput.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>FilterAvailableAttributeInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeType!]</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

---

## ImageCsvInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/image-csv-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for bulk importing images from a CSV file with field mapping configuration

```graphql
input ImageCsvInput {
  file: Upload!
  mappings: [ImageCsvMapping!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ImageCsvInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Upload!</b></code>](/reference/legacy/graphql-v1/scalars/upload.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

CSV file containing image data for bulk import.

    Must be a valid CSV file with headers that match the configured field mappings. Each row represents one image to be created with the specified metadata and file references.

#### [<code style={{ fontWeight: 'normal' }}>ImageCsvInput.<b>mappings</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ImageCsvMapping!]</b></code>](/reference/legacy/graphql-v1/inputs/image-csv-mapping.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Configuration mapping CSV columns to image entity fields.

    Defines how CSV column headers correspond to image fields. If not provided, the system will attempt to auto-map based on standard column names. Each mapping must be unique and valid.

### Member Of

[`mediaImageCsvImport`](/reference/legacy/graphql-v1/mutations/media-image-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ImageCsvMapping

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/image-csv-mapping

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Mapping configuration between CSV column headers and image entity fields

```graphql
input ImageCsvMapping {
  csvHeader: String!
  fieldName: ImageFieldName!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ImageCsvMapping.<b>csvHeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Name of the column header in the CSV file.

    Must exactly match the column header in the uploaded CSV file. Used to identify which CSV column contains the data for the corresponding image field.

#### [<code style={{ fontWeight: 'normal' }}>ImageCsvMapping.<b>fieldName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ImageFieldName!</b></code>](/reference/legacy/graphql-v1/enums/image-field-name.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Target image field that will receive the CSV column data.

    Specifies which image entity field should be populated with the data from the corresponding CSV column. Each field has specific validation requirements and data format expectations.

### Member Of

[`ImageCsvInput`](/reference/legacy/graphql-v1/inputs/image-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ImageTransformationInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/image-transformation-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ImageTransformationInput {
  name: String!
  transformation: TransformationInput!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ImageTransformationInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Friendly name for your image transformation

#### [<code style={{ fontWeight: 'normal' }}>ImageTransformationInput.<b>transformation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransformationInput!</b></code>](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Image transformation options

### Member Of

[`TransformationsInput`](/reference/legacy/graphql-v1/inputs/transformations-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## IncentiveRuleOrderItemSetCellInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input IncentiveRuleOrderItemSetCellInput {
  ruleId: ID!
  rowId: ID!
  expression: BusinessRuleExpressionGroupInput
  value: String
  localizedValue: [LocalizedStringInput!]
  number: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the BusinessRule that contains the table cell

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>rowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the row the table cell

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>expression</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroupInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-expression-group-input.mdx) <Badge class="badge badge--secondary " text="input"/>

The expressions value for this cell

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The string value of the cell, used in output cells. Can contain a string or an expression. Strings need to be wrapped in ""

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>localizedValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The localized string value of the cell, used in output cells. Used when you want a rule to generate a translated string in the output

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleOrderItemSetCellInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The numeric value for this cell, used in output cells

### Member Of

[`incentiveRuleSetOrderItemConditions`](/reference/legacy/graphql-v1/mutations/incentive-rule-set-order-item-conditions.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## IncentiveRuleSetActionInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input IncentiveRuleSetActionInput {
  ruleId: ID!
  rowId: ID!
  action: IncentiveActions!
  name: [LocalizedStringInput!]!
  productId: Int
  price: Float
  quantity: Int
  discount: Float
  discountType: IncentiveDiscountType
  valuePoints: Float
  repeat: YesNo
  actionCode: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>rowId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>action</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IncentiveActions!</b></code>](/reference/legacy/graphql-v1/enums/incentive-actions.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>discountType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IncentiveDiscountType</b></code>](/reference/legacy/graphql-v1/enums/incentive-discount-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>repeat</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>IncentiveRuleSetActionInput.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The action code that was applied by this rule. Should match the order.actionCode field in the inputs

### Member Of

[`incentiveRuleSetAction`](/reference/legacy/graphql-v1/mutations/incentive-rule-set-action.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## InventoryCsvInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/inventory-csv-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input InventoryCsvInput {
  file: Upload!
  mappings: [InventoryCsvMapping!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>InventoryCsvInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Upload!</b></code>](/reference/legacy/graphql-v1/scalars/upload.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

CSV file

#### [<code style={{ fontWeight: 'normal' }}>InventoryCsvInput.<b>mappings</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[InventoryCsvMapping!]</b></code>](/reference/legacy/graphql-v1/inputs/inventory-csv-mapping.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

A list of inventories CSV field mappings

### Member Of

[`inventoryCsvImport`](/reference/legacy/graphql-v1/mutations/inventory-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## InventoryCsvMapping

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/inventory-csv-mapping

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input InventoryCsvMapping {
  csvHeader: String!
  fieldName: InventoryFieldName!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>InventoryCsvMapping.<b>csvHeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the column in the CSV file

#### [<code style={{ fontWeight: 'normal' }}>InventoryCsvMapping.<b>fieldName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>InventoryFieldName!</b></code>](/reference/legacy/graphql-v1/enums/inventory-field-name.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The name of the field in Propeller eCommerce Platform

### Member Of

[`InventoryCsvInput`](/reference/legacy/graphql-v1/inputs/inventory-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## LocalizedStringArrayInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/localized-string-array-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input LocalizedStringArrayInput {
  language: String!
  values: [String!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringArrayInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language is set as 2 character country code.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringArrayInput.<b>values</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeSearchInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeValueInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## LocalizedStringInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/localized-string-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

A String representation of a type Field that is suitable for Localization

```graphql
input LocalizedStringInput {
  language: String!
  value: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Localized field language code

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Localized field value

### Member Of

[`BusinessRuleCreateInput`](/reference/legacy/graphql-v1/inputs/business-rule-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableSetCellInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleUpdateInput`](/reference/legacy/graphql-v1/inputs/business-rule-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarrierCreateInput`](/reference/legacy/graphql-v1/inputs/carrier-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarrierUpdateInput`](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateCategoryInput`](/reference/legacy/graphql-v1/inputs/create-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateSparePartInput`](/reference/legacy/graphql-v1/inputs/create-spare-part-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleOrderItemSetCellInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistCreateInput`](/reference/legacy/graphql-v1/inputs/orderlist-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistUpdateInput`](/reference/legacy/graphql-v1/inputs/orderlist-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodCreateInput`](/reference/legacy/graphql-v1/inputs/pay-method-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodUpdateInput`](/reference/legacy/graphql-v1/inputs/pay-method-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCategoryInput`](/reference/legacy/graphql-v1/inputs/update-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpsertSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItemCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItemUpdateInput`](/reference/legacy/graphql-v1/inputs/valueset-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetUpdateInput`](/reference/legacy/graphql-v1/inputs/valueset-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## LoginInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/login-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input LoginInput {
  email: String!
  password: String!
  provider: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LoginInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>LoginInput.<b>password</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>LoginInput.<b>provider</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`login`](/reference/legacy/graphql-v1/mutations/login.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaAttachmentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-attachment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input MediaAttachmentInput {
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]!
  description: [MediaLocalizedStringInput!]!
  tags: [MediaLocalizedStringArrayInput!]!
  priority: Int
  uploadAttachments: [UploadFileInput!]!
  orderId: Int
  companyId: Int
  customerId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>uploadAttachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UploadFileInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Upload File input reference

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique order identifier that the attachment relates to. [Cannot use it together with sparePartsMachineId]

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique company identifier that the attachment relates to. [Cannot use it together with customerId]

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique customer identifier that the attachment relates to. [Cannot use it together with companyId]

### Member Of

[`mediaAttachmentCreate`](/reference/legacy/graphql-v1/mutations/media-attachment-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaAttachmentSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-attachment-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and filter criteria specifically for private attachment files

```graphql
input MediaAttachmentSearchInput {
  sparePartsMachineId: String
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
  orderId: Int
  companyId: Int
  customerId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter attachments associated with a specific order.

    Retrieves attachments linked to the specified order ID. Cannot be used simultaneously with sparePartsMachineId as attachments are associated with either orders or machines, not both.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter attachments owned by a specific company.

    Retrieves attachments that belong to the specified company. Cannot be used simultaneously with customerId as attachments have a single owner type.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachmentSearchInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter attachments owned by a specific customer.

    Retrieves attachments that belong to the specified customer. Cannot be used simultaneously with companyId as attachments have a single owner type.

---

## MediaBase64FileInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-base-64-file-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

File upload using base64 encoded content for direct data transmission

```graphql
input MediaBase64FileInput {
  base64: String!
  fileName: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaBase64FileInput.<b>base64</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Base64 encoded representation of the file content.

    The complete file data encoded in base64 format. Maximum size is approximately 10MB (13,981,017 characters). This method is useful for small files or when direct file upload is not available.

#### [<code style={{ fontWeight: 'normal' }}>MediaBase64FileInput.<b>fileName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Filename to use when creating the file from base64 data.

    Must include the file extension and be between 5-255 characters. This name will be used for storage and affects how the file is processed and referenced.

### Member Of

[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## MediaDocumentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-document-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input MediaDocumentInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]!
  description: [MediaLocalizedStringInput!]!
  tags: [MediaLocalizedStringArrayInput!]!
  priority: Int
  uploadDocuments: [UploadFileInput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentInput.<b>uploadDocuments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UploadFileInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Upload File input reference

### Member Of

[`mediaDocumentCreate`](/reference/legacy/graphql-v1/mutations/media-document-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaDocumentProductSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-document-product-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for documents associated with a specific product, excluding entity association fields

```graphql
input MediaDocumentProductSearchInput {
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentProductSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentProductSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentProductSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentProductSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentProductSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

---

## MediaDocumentSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-document-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and filter criteria specifically for document media items

```graphql
input MediaDocumentSearchInput {
  productId: Int
  categoryId: Int
  clusterId: Int
  sparePartsMachineId: String
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocumentSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

### Member Of

[`mediaDocuments`](/reference/legacy/graphql-v1/deprecated/queries/media-documents.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## MediaImageInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-image-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input MediaImageInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]!
  description: [MediaLocalizedStringInput!]!
  tags: [MediaLocalizedStringArrayInput!]!
  priority: Int
  uploadImages: [UploadFileInput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageInput.<b>uploadImages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UploadFileInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Upload File input reference

### Member Of

[`mediaImageCreate`](/reference/legacy/graphql-v1/mutations/media-image-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaImageProductSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-image-product-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for images associated with a specific product, excluding entity association fields

```graphql
input MediaImageProductSearchInput {
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaImageProductSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageProductSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageProductSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageProductSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageProductSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

---

## MediaImageSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-image-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and filter criteria specifically for image media items

```graphql
input MediaImageSearchInput {
  productId: Int
  categoryId: Int
  clusterId: Int
  sparePartsMachineId: String
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaImageSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

### Member Of

[`mediaImages`](/reference/legacy/graphql-v1/deprecated/queries/media-images.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## MediaLocalizedStringArrayInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-localized-string-array-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Localized array of string values with language specification for tags and multi-value fields

```graphql
input MediaLocalizedStringArrayInput {
  language: String!
  values: [String!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaLocalizedStringArrayInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for the localized content.

    Must be a valid 2-character language code (e.g., 'EN', 'DE', 'FR'). Used to identify the language of the associated string array values for proper localization and display.

#### [<code style={{ fontWeight: 'normal' }}>MediaLocalizedStringArrayInput.<b>values</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Array of text values in the specified language.

    Multiple string values for the specified language, commonly used for tags, keywords, or categories. Each value should be meaningful and relevant to the associated media content.

### Member Of

[`MediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentInput`](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageInput`](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoInput`](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/update-media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## MediaLocalizedStringInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-localized-string-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Localized string value with language specification for internationalization support

```graphql
input MediaLocalizedStringInput {
  language: String!
  value: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaLocalizedStringInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for the localized content.

    Must be a valid 2-character language code (e.g., 'EN', 'DE', 'FR'). Used to identify the language of the associated text value for proper localization and display.

#### [<code style={{ fontWeight: 'normal' }}>MediaLocalizedStringInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text content in the specified language.

    The actual text value for the specified language. Must be between 3-255 characters and contain meaningful content for the associated field.

### Member Of

[`MediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaAttachmentSearchInput`](/reference/legacy/graphql-v1/inputs/media-attachment-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentInput`](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageInput`](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoInput`](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ObjectMediaSearchInput`](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/update-media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## MediaVideoInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-video-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input MediaVideoInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]!
  description: [MediaLocalizedStringInput!]!
  tags: [MediaLocalizedStringArrayInput!]!
  priority: Int
  videos: [UploadVideoInput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoInput.<b>videos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UploadVideoInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/upload-video-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Store Video input reference

### Member Of

[`mediaVideoCreate`](/reference/legacy/graphql-v1/mutations/media-video-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaVideoProductSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-video-product-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for videos associated with a specific product, excluding entity association fields

```graphql
input MediaVideoProductSearchInput {
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoProductSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoProductSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoProductSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoProductSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoProductSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

---

## MediaVideoSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/media-video-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and filter criteria specifically for video media items

```graphql
input MediaVideoSearchInput {
  productId: Int
  categoryId: Int
  clusterId: Int
  sparePartsMachineId: String
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter media items associated with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideoSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

### Member Of

[`mediaVideos`](/reference/legacy/graphql-v1/deprecated/queries/media-videos.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ObjectMediaSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/object-media-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ObjectMediaSearchInput {
  description: MediaLocalizedStringInput
  tag: MediaLocalizedStringInput
  sort: Sort
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ObjectMediaSearchInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item descriptions.

    Performs text search against the description field in the specified language. Supports partial matching and is case-insensitive.

#### [<code style={{ fontWeight: 'normal' }}>ObjectMediaSearchInput.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaLocalizedStringInput</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search within media item tags.

    Finds media items that have tags matching the specified value in the given language. Useful for content categorization and discovery.

#### [<code style={{ fontWeight: 'normal' }}>ObjectMediaSearchInput.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Sort</b></code>](/reference/legacy/graphql-v1/enums/sort.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order for search results.

    Controls whether results are returned in ascending or descending order. Sorting is typically applied to the priority field or creation date.

#### [<code style={{ fontWeight: 'normal' }}>ObjectMediaSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Pages start at 1.

#### [<code style={{ fontWeight: 'normal' }}>ObjectMediaSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many media items are returned in each page of results. Maximum recommended value is 50 for performance.

---

## OrderCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderCreateInput {
  userId: Int!
  accountManagerId: Int
  channelId: Int
  accountingId: String
  debtorId: String
  debtorFirstName: String
  debtorLastName: String
  debtorCompany: String
  recipientFirstName: String
  recipientLastName: String
  recipientCompany: String
  externalId: String
  status: String!
  type: OrderType!
  source: String
  email: String!
  remarks: String
  reference: String
  extra3: String
  extra4: String
  currency: String!
  currencyRatio: Float
  language: String!
  valuePoints: Int
  actionCode: String
  invoiceUserId: Int
  validUntil: String
  companyId: Int
  companySource: SourceInput
  originalOrderId: Int
  exportedAt: String
  exportStatus: OrderExportStatus
  exportMessage: String
  shopId: Int!
  cartId: String
  items: [OrderItemCreateInput!]!
  paymentData: OrderPaymentInput!
  postageData: OrderPostageInput!
  total: OrderTotalInput!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID of the User, Contact or Customer of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>accountManagerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User ID of the Account Manager of the order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Channel ID the Order belongs to

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Accounting ID of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Debtor ID of the User, Contact or Customer

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>debtorFirstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>debtorLastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>debtorCompany</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>recipientFirstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>recipientLastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>recipientCompany</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the Order in an external system

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Status of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderType!</b></code>](/reference/legacy/graphql-v1/enums/order-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Type of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Source of the Order i.e. webshop, internal, external or api

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Email address used for communication about this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>remarks</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Remarks by the customer

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Reference by the customer

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra3: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra4: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order currency - ISO 4217 currency code =&#x003E; https://www.xe.com/iso4217.php

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>currencyRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Currency conversion ratio compared the the Order's Shop's base currency

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order language - ISO 639-1 language code =&#x003E; https://localizely.com/iso-639-1-list/

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Value points collected with this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Active actioncode that was applied to this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>invoiceUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the User, Contact or Customer that should receive the invoice for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>validUntil</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date and time until the order is valid

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the Company of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>companySource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A company source

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>originalOrderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original order id

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>exportedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time the order was exported

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>exportStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderExportStatus</b></code>](/reference/legacy/graphql-v1/enums/order-export-status.mdx) <Badge class="badge badge--secondary " text="enum"/>

Order export status of this order

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>exportMessage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order export message

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the shop the Order belongs to

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The ID of the Cart the Order belongs to

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderItemCreateInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

The OrderItem to create with the Order as a single bulk request

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPaymentInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-payment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Order's payment data

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPostageInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Order's postage data

#### [<code style={{ fontWeight: 'normal' }}>OrderCreateInput.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderTotalInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-total-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Order's totals, tax and global discount

### Member Of

[`orderCreate`](/reference/legacy/graphql-v1/mutations/order-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderItemCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-item-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderItemCreateInput {
  class: OrderItemClass!
  uuid: String
  productId: Int
  productSource: SourceInput
  parentOrderItemId: Int
  parentOrderItemUUID: String
  quantity: Int!
  sku: String!
  notes: String
  name: String
  supplier: String
  supplierCode: String
  manufacturer: String
  manufacturerCode: String
  eanCode: String
  originalPrice: Float!
  customerPrice: Float
  price: Float!
  priceTotal: Float!
  priceNet: Float
  priceTotalNet: Float
  costPrice: Float
  discount: Float
  tax: Float
  taxPercentage: Int!
  taxCode: Taxcode!
  isBonus: YesNo!
  minumumQuantity: Int
  minimumQuantity: Int
  unit: Int
  package: String
  packageUnit: String
  packageUnitQuantity: String
  purchaseUnit: Int
  purchaseMinimumQuantity: Int
  requestDate: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemClass!</b></code>](/reference/legacy/graphql-v1/enums/order-item-class.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The class of the orderItem. Either product, incentive, surcharge, postage, payment

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>uuid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The UUID for the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The productId of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>productSource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A product source

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>parentOrderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The ID of the parent OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>parentOrderItemUUID</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The UUID of the parent OrderItem, this can be used in bulk operations where the auto-increment ID's are not known

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The SKU of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Remarks by the customer for the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The name of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplierCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturerCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The eanCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The original price of the OrderItem, before applying any discounts

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated customerPrice of the OrderItem at the time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The calculated price per unit excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>priceTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of the OrderItem excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated price per unit including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>priceTotalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total price of the OrderItem including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cost price of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total tax of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>isBonus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is the OrderItem a bonusItem?

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>minumumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The minimum quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The minimum quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>packageUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>packageUnitQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package unit quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>purchaseUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The purchase unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>purchaseMinimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The purchase minimum quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemCreateInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Requested delivery date for this orderline

### Member Of

[`CreateOrUpdateOrderItemInput`](/reference/legacy/graphql-v1/inputs/create-or-update-order-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderItemCreate`](/reference/legacy/graphql-v1/mutations/order-item-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderItemUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-item-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderItemUpdateInput {
  id: Int!
  quantity: Int!
  notes: String
  priceNet: Float
  price: Float!
  priceTotal: Float!
  priceTotalNet: Float
  discount: Float!
  tax: Float!
  taxPercentage: Int!
  originalPrice: Float!
  taxCode: Taxcode!
  customerPrice: Float
  costPrice: Float
  requestDate: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the orderitem to update.

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity of the orderitem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The orderitem notes

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated price per unit including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross price per unit excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>priceTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of the orderitem excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>priceTotalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total price of the OrderItem including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount applied to this orderitem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of tax applied to this orderitem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage applied to this orderitem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The original price of the OrderItem, before applying any discounts

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated user specific price of the orderitem, before applying any additional discounts

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The costprice of the orderitem

#### [<code style={{ fontWeight: 'normal' }}>OrderItemUpdateInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Requested delivery date for this orderline

### Member Of

[`CreateOrUpdateOrderItemInput`](/reference/legacy/graphql-v1/inputs/create-or-update-order-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderItemUpdate`](/reference/legacy/graphql-v1/mutations/order-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderPaymentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-payment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderPaymentInput {
  net: Float!
  gross: Float!
  tax: Float!
  taxPercentage: Float!
  method: String!
  status: String
  statusDate: DateTime
  accountingId: String
  overruled: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The paymethod for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction status

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>statusDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last time the transaction status was changed

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The accountingId that belongs to this order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentInput.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the transaction costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

### Member Of

[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderPaymentUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-payment-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderPaymentUpdateInput {
  net: Float
  gross: Float
  tax: Float
  taxPercentage: Float
  method: String
  status: String
  statusDate: DateTime
  accountingId: String
  overruled: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The paymethod for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction status

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>statusDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last time the transaction status was changed

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The accountingId that belongs to this order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentUpdateInput.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the transaction costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

### Member Of

[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderPostageInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-postage-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderPostageInput {
  method: String!
  taxPercentage: Float!
  requestDate: DateTime
  gross: Float!
  net: Float!
  tax: Float!
  partialDeliveryAllowed: YesNo
  pickUpLocationId: Int
  carrier: String
  overruled: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The chosen shipping method

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The provided delivery date for the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Is partial delivery allowed for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the pick up location when the Order's shipping method is PICKUP

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageInput.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the shipping costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

### Member Of

[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderPostageUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-postage-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderPostageUpdateInput {
  method: String
  taxPercentage: Float
  requestDate: DateTime
  gross: Float
  net: Float
  tax: Float
  partialDeliveryAllowed: YesNo
  pickUpLocationId: Int
  carrier: String
  overruled: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The chosen shipping method

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The provided delivery date for the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Is partial delivery allowed for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the pick up location when the Order's shipping method is PICKUP

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageUpdateInput.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the shipping costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

### Member Of

[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderSearchArguments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-search-arguments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderSearchArguments {
  userId: [Int!]
  status: [String!]
  type: [OrderType!]
  page: Int
  offset: Int
  term: String
  termFields: [OrderSearchFields!]
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  price: DecimalSearchInput
  companyIds: [Int!]
  companySources: [SourceInput!]
  originalOrderIds: [Int!]
  exportStatuses: [OrderExportStatus!]
  exportedAt: DateSearchInput
  sortInputs: [OrderSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Pass one order more userId's to retrieve order for

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Only search for orders in these statuses

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderType!]</b></code>](/reference/legacy/graphql-v1/enums/order-type.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Only search for orders of the types

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Search term

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>termFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderSearchFields!]</b></code>](/reference/legacy/graphql-v1/enums/order-search-fields.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of fields to search in

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date created

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DecimalSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/decimal-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by price range

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Search by company ids

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>companySources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SourceInput!]</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sources

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>originalOrderIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Search by original order ids

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>exportStatuses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderExportStatus!]</b></code>](/reference/legacy/graphql-v1/enums/order-export-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

Only search for orders with export status

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>exportedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by export date

#### [<code style={{ fontWeight: 'normal' }}>OrderSearchArguments.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/order-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Inputs to sort by

### Member Of

[`orders`](/reference/legacy/graphql-v1/queries/orders.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## OrderSetStatusInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-set-status-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderSetStatusInput {
  orderId: Int!
  status: String
  payStatus: String
  sendOrderConfirmationEmail: Boolean
  addPDFAttachment: Boolean
  deleteCart: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the order to set the status for

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The status of the order

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>payStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The payment status of the order

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>sendOrderConfirmationEmail</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Send the order confirmation email when the status is changed

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>addPDFAttachment</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Add the order overview as attached PDF to the order confirmation email

#### [<code style={{ fontWeight: 'normal' }}>OrderSetStatusInput.<b>deleteCart</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Delete the cart that created this order if the cart is still available

### Member Of

[`orderSetStatus`](/reference/legacy/graphql-v1/mutations/order-set-status.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderSortInput {
  field: OrderSortField!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderSortField!</b></code>](/reference/legacy/graphql-v1/enums/order-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Field to sort by

#### [<code style={{ fontWeight: 'normal' }}>OrderSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order option to sort by. [Default to `ASC`]

### Member Of

[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderTotalInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-total-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderTotalInput {
  gross: Float!
  net: Float!
  tax: Float!
  discountType: OrderDiscountType!
  discountValue: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total amount of tax for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalInput.<b>discountType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderDiscountType!</b></code>](/reference/legacy/graphql-v1/enums/order-discount-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of global discount

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalInput.<b>discountValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount value, can be absolute or a percentage depending on the discountType

### Member Of

[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderTotalUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-total-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderTotalUpdateInput {
  gross: Float
  net: Float
  tax: Float
  discountType: OrderDiscountType
  discountValue: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalUpdateInput.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalUpdateInput.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalUpdateInput.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total amount of tax for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalUpdateInput.<b>discountType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderDiscountType</b></code>](/reference/legacy/graphql-v1/enums/order-discount-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

The type of global discount

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalUpdateInput.<b>discountValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount value, can be absolute or a percentage depending on the discountType

### Member Of

[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderUpdateAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-update-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderUpdateAddressInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  icp: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 20]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 20]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateAddressInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

### Member Of

[`orderUpdateAddress`](/reference/legacy/graphql-v1/mutations/order-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/order-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderUpdateInput {
  userId: Int
  accountManagerId: Int
  channelId: Int
  accountingId: String
  debtorId: String
  debtorFirstName: String
  debtorLastName: String
  debtorCompany: String
  recipientFirstName: String
  recipientLastName: String
  recipientCompany: String
  externalId: String
  status: String
  type: OrderType
  source: String
  email: String
  remarks: String
  reference: String
  extra3: String
  extra4: String
  currency: String
  currencyRatio: Float
  language: String
  valuePoints: Int
  actionCode: String
  invoiceUserId: Int
  validUntil: String
  companyId: Int
  companySource: SourceInput
  originalOrderId: Int
  exportedAt: String
  exportStatus: OrderExportStatus
  exportMessage: String
  items: [CreateOrUpdateOrderItemInput!]
  paymentData: OrderPaymentUpdateInput
  postageData: OrderPostageUpdateInput
  total: OrderTotalUpdateInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the User, Contact or Customer of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>accountManagerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User ID of the Account Manager of the order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Channel ID the Order belongs to

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Accounting ID of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Debtor ID of the User, Contact or Customer

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>debtorFirstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>debtorLastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>debtorCompany</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company name of the Debtor [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>recipientFirstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>recipientLastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>recipientCompany</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company name of the Recipient [USED FOR ORDER SEARCH ONLY]

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the Order in an external system

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Status of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderType</b></code>](/reference/legacy/graphql-v1/enums/order-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Type of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Source of the Order i.e. webshop, internal, external or api

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email address used for communication about this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>remarks</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Remarks by the customer

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Reference by the customer

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra3: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra4: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order currency - ISO 4217 currency code =&#x003E; https://www.xe.com/iso4217.php

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>currencyRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Currency conversion ratio compared the the Order's Shop's base currency

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order language - ISO 639-1 language code =&#x003E; https://localizely.com/iso-639-1-list/

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Value points collected with this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Active actioncode that was applied to this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>invoiceUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the User, Contact or Customer that should receive the invoice for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>validUntil</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date and time until the order is valid

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the Company of the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>companySource</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SourceInput</b></code>](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary " text="input"/>

A company source

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>originalOrderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original order id

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>exportedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time the order was exported

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>exportStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderExportStatus</b></code>](/reference/legacy/graphql-v1/enums/order-export-status.mdx) <Badge class="badge badge--secondary " text="enum"/>

Order export status of this order

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>exportMessage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order export message

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CreateOrUpdateOrderItemInput!]</b></code>](/reference/legacy/graphql-v1/inputs/create-or-update-order-item-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The OrderItem to create or update with the Order as a single bulk request

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPaymentUpdateInput</b></code>](/reference/legacy/graphql-v1/inputs/order-payment-update-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Order's payment data

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPostageUpdateInput</b></code>](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Order's postage data

#### [<code style={{ fontWeight: 'normal' }}>OrderUpdateInput.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderTotalUpdateInput</b></code>](/reference/legacy/graphql-v1/inputs/order-total-update-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Order's totals, tax and global discount

### Member Of

[`orderUpdate`](/reference/legacy/graphql-v1/mutations/order-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderlistCompaniesInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-companies-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistCompaniesInput {
  companyIds: [Int!]!
  companySources: [Source!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCompaniesInput.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

List of company ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCompaniesInput.<b>companySources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sources

### Member Of

[`orderlistAssignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-assign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUnassignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderlistCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistCreateInput {
  productIds: [Int!]
  productSources: [Source!]
  clusterIds: [Int!]
  clusterSources: [Source!]
  type: OrderlistType!
  descriptions: [LocalizedStringInput!]
  userIds: [Int!]
  userSources: [Source!]
  companyIds: [Int!]
  companySources: [Source!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of cluster ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistType!</b></code>](/reference/legacy/graphql-v1/enums/orderlist-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Orderlist type! One of: [POSITIVE, NEGATIVE]

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Orderlist descriptions per language

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of user ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>userSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of user sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of company ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistCreateInput.<b>companySources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sources

### Member Of

[`orderlistCreate`](/reference/legacy/graphql-v1/mutations/orderlist-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderlistItemsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-items-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistItemsInput {
  productIds: [Int!]
  productSources: [Source!]
  clusterIds: [Int!]
  clusterSources: [Source!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistItemsInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistItemsInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistItemsInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of cluster ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistItemsInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

### Member Of

[`orderlistAddItems`](/reference/legacy/graphql-v1/mutations/orderlist-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistRemoveItems`](/reference/legacy/graphql-v1/mutations/orderlist-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderlistSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  ids: [Int!]
  type: OrderlistType
  userIds: [Int!]
  userSources: [Source!]
  companyIds: [Int!]
  companySources: [Source!]
  productIds: [Int!]
  productSources: [Source!]
  clusterIds: [Int!]
  clusterSources: [Source!]
  sortInputs: [OrderlistSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number. [Default to `1`]

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number. [Default to `12`]

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date created

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search by date changed

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of Orderlist primary identifiers

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistType</b></code>](/reference/legacy/graphql-v1/enums/orderlist-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Orderlist type. One of: [POSITIVE, NEGATIVE]

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of user ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>userSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of user sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of company ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>companySources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of cluster ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSearchInput.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderlistSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Inputs to sort by

### Member Of

[`orderlists`](/reference/legacy/graphql-v1/queries/orderlists.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## OrderlistSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistSortInput {
  field: OrderlistSortField!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistSortField!</b></code>](/reference/legacy/graphql-v1/enums/orderlist-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Field to sort by

#### [<code style={{ fontWeight: 'normal' }}>OrderlistSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order option to sort by. [Default to `ASC`]

### Member Of

[`OrderlistSearchInput`](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## OrderlistUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistUpdateInput {
  productIds: [Int!]
  productSources: [Source!]
  clusterIds: [Int!]
  clusterSources: [Source!]
  type: OrderlistType
  descriptions: [LocalizedStringInput!]
  userIds: [Int!]
  userSources: [Source!]
  companyIds: [Int!]
  companySources: [Source!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>productSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>clusterIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of cluster ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>clusterSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of cluster sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistType</b></code>](/reference/legacy/graphql-v1/enums/orderlist-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Orderlist type! One of: [POSITIVE, NEGATIVE]

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Orderlist descriptions per language

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of user ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>userSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of user sources

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>companyIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of company ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUpdateInput.<b>companySources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of company sources

### Member Of

[`orderlistUpdate`](/reference/legacy/graphql-v1/mutations/orderlist-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## OrderlistUsersInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/orderlist-users-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input OrderlistUsersInput {
  userIds: [Int!]
  userSources: [Source!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUsersInput.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of user ids

#### [<code style={{ fontWeight: 'normal' }}>OrderlistUsersInput.<b>userSources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Source!]</b></code>](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of user sources

### Member Of

[`orderlistAssignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-assign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUnassignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## PadInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/pad-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Add pixels to the edge of an image.

Notes

- By default padding applies a background color of white. See bg-color to change that.
- If the source image contains a transparent background and the output image also contains transparency, the padding will be made up of transparent pixels.
- When using pad and canvas at the same time, pad will be ignored.
- Values can be specified using CSS style shorthand values. (see CSS Margin or CSS Padding for more examples).
- CSS shorthand allows for all edges to be specified in one property.
- Any fractional pixel measurements will be rounded to the nearest whole pixel.

```graphql
input PadInput {
  top: Int
  right: Int
  bottom: Int
  left: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PadInput.<b>top</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Top - Pixels or Percentage - Default=0

#### [<code style={{ fontWeight: 'normal' }}>PadInput.<b>right</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Right - Pixels or Percentage - Default=0

#### [<code style={{ fontWeight: 'normal' }}>PadInput.<b>bottom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Bottom - Pixels or Percentage - Default=0

#### [<code style={{ fontWeight: 'normal' }}>PadInput.<b>left</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Left - Pixels or Percentage - Default=0

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## PasswordRecoveryLinkInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/password-recovery-link-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input PasswordRecoveryLinkInput {
  email: String!
  redirectUrl: String
  language: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PasswordRecoveryLinkInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email address of the user to generate the recovery link for

#### [<code style={{ fontWeight: 'normal' }}>PasswordRecoveryLinkInput.<b>redirectUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The page the user will be redirected to after the user changed his/her password.

#### [<code style={{ fontWeight: 'normal' }}>PasswordRecoveryLinkInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`passwordResetLink`](/reference/legacy/graphql-v1/mutations/password-reset-link.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## PasswordResetLinkEmailInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/password-reset-link-email-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input PasswordResetLinkEmailInput {
  type: EmailEventType!
  siteId: Int
  orderId: Int
  userId: Int
  letterId: String
  subject: String
  content: String
  from: EmailSendContactInput
  attachments: [Base64FileInput!]
  variables: JSONObject
  language: String
  email: String!
  redirectUrl: String
  linkText: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailEventType!</b></code>](/reference/legacy/graphql-v1/enums/email-event-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of email event to trigger

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the site to use when sending the email, required when the site can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the order to use when triggering an event of type orderconfirm

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the user to send to email to. Can be used to replace to, when the user can't be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>letterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the Propeller letter to use when type is 'campaign'

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>subject</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The subject of the email, use when the subject can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>content</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The content of the email, use when the content can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailSendContactInput</b></code>](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary " text="input"/>

The sender of the email, use when the sender can not be derived from other inputs

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Base64FileInput!]</b></code>](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Attachments to add to the email

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>variables</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Variables that can be used in the email template

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email address of the user to generate the recovery link for

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>redirectUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The page the user will be redirected to after the user changed their password.

#### [<code style={{ fontWeight: 'normal' }}>PasswordResetLinkEmailInput.<b>linkText</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Text to display that will lead to link when clicked

### Member Of

[`publishPasswordResetEmailEvent`](/reference/legacy/graphql-v1/mutations/publish-password-reset-email-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## PayMethodCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/pay-method-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for creating a new payment method.

Contains all necessary information to establish a new payment method including localized names, external system integration codes, and branding elements. Used for setting up new payment options in checkout flows.

```graphql
input PayMethodCreateInput {
  names: [LocalizedStringInput!]!
  externalCode: String!
  logo: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethodCreateInput.<b>names</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Localized payment method names for different languages.

    Collection of payment method names in various languages for international checkout experiences. Each language must be unique and follow ISO 639-1 format. At least one localized name is required.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodCreateInput.<b>externalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

External system identifier in SCREAMING_SNAKE_CASE format.

    Unique code used to identify this payment method in external payment processors and gateways. Must follow SCREAMING&#x005F;SNAKE&#x005F;CASE convention and be unique across all payment methods. Maximum 64 characters.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodCreateInput.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method logo URL for checkout display.

    Optional URL pointing to the payment method's logo or icon for visual identification in checkout interfaces. Must be a valid URL format with maximum 255 characters.

### Member Of

[`payMethodCreate`](/reference/legacy/graphql-v1/mutations/pay-method-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## PayMethodSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/pay-method-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for filtering payment methods with comprehensive options.

Provides flexible search capabilities for payment method discovery including date range filtering, identifier-based searches, and custom sorting. Supports pagination for large payment method catalogs.

```graphql
input PayMethodSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  ids: [Int!]
  externalCodes: [String!]
  sortInputs: [PayMethodSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination.

    Specifies which page of results to return. Must be a positive integer (minimum value: 1). Default is page 1.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page.

    Controls how many payment methods are returned in each page. Must be a positive integer (minimum value: 1). Default is 12 payment methods per page.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter by payment method creation date range.

    Allows filtering payment methods based on when they were originally created in the system. Useful for finding recently added payment methods.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter by payment method last modification date range.

    Allows filtering payment methods based on when they were last updated. Useful for finding recently modified payment methods or tracking changes.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific payment method identifiers.

    Returns only payment methods whose IDs match the provided list. Each ID must be a positive integer (minimum value: 1) and unique within the array. Useful for retrieving specific payment methods or bulk operations.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>externalCodes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by external system codes.

    Returns payment methods matching any of the specified external codes used for payment processor integration. Each code must follow SCREAMING&#x005F;SNAKE&#x005F;CASE format (pattern: ^([A-Z]&#x002A;&#x005F;?[A-Z]&#x002A;)&#x002A;$), have maximum length of 64 characters, and be unique within the array.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSearchInput.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[PayMethodSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/pay-method-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Sorting configuration for result ordering.

    Defines how the payment method results should be sorted, supporting multiple sort criteria with different directions (ascending/descending). Each sort input must be unique within the array.

### Member Of

[`payMethods`](/reference/legacy/graphql-v1/queries/pay-methods.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## PayMethodSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/pay-method-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sorting configuration for payment method results.

Defines a single sort criterion with field and direction for ordering payment method query results.

```graphql
input PayMethodSortInput {
  field: PayMethodSortField!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PayMethodSortField!</b></code>](/reference/legacy/graphql-v1/enums/pay-method-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Field to sort payment methods by.

    Specifies which payment method property to use for sorting the results.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort order direction.

    Specifies whether to sort in ascending or descending order. Defaults to ascending order.

### Member Of

[`PayMethodSearchInput`](/reference/legacy/graphql-v1/inputs/pay-method-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## PayMethodUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/pay-method-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for updating an existing payment method with partial data.

Allows partial updates of payment method properties including localized names, external integration codes, and branding elements. Only provided fields will be updated, others remain unchanged.

Validation constraints:

- Names array must contain unique languages if provided (minimum 1 item)
- External code must follow SCREAMING_SNAKE_CASE format and be unique (maximum 64 characters)
- Logo URL must be valid if provided (maximum 255 characters)

```graphql
input PayMethodUpdateInput {
  names: [LocalizedStringInput!]
  externalCode: String
  logo: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethodUpdateInput.<b>names</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Localized payment method names for different languages.

    Collection of payment method names in various languages for international checkout experiences. Each language must be unique and follow ISO 639-1 format. At least one localized name is required.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodUpdateInput.<b>externalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External system identifier in SCREAMING_SNAKE_CASE format.

    Unique code used to identify this payment method in external payment processors and gateways. Must follow SCREAMING&#x005F;SNAKE&#x005F;CASE convention and be unique across all payment methods. Maximum 64 characters.

#### [<code style={{ fontWeight: 'normal' }}>PayMethodUpdateInput.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method logo URL for checkout display.

    Optional URL pointing to the payment method's logo or icon for visual identification in checkout interfaces. Must be a valid URL format with maximum 255 characters.

### Member Of

[`payMethodUpdate`](/reference/legacy/graphql-v1/mutations/pay-method-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## PaymentsSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/payments-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and pagination parameters for retrieving payment records.

Controls the pagination behavior and response expansion options for payment queries. Provides efficient data retrieval with configurable page sizes and optional related data inclusion.

```graphql
input PaymentsSearchInput {
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaymentsSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination navigation starting from 1.

Specifies which page of results to retrieve when the total number of payments exceeds the offset limit. Minimum value is 1. Defaults to 1 if not specified.

#### [<code style={{ fontWeight: 'normal' }}>PaymentsSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page for controlling response size.

Controls the size of each page in the paginated response to manage data volume and performance. Minimum value is 1, maximum value is 100. Defaults to 12 if not specified.

### Member Of

[`payments`](/reference/legacy/graphql-v1/queries/payments.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## PriceFilterInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/price-filter-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input PriceFilterInput {
  from: Float!
  to: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PriceFilterInput.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Price from filter

#### [<code style={{ fontWeight: 'normal' }}>PriceFilterInput.<b>to</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Price to filter

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## RangeFilterInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/range-filter-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input RangeFilterInput {
  from: Float!
  to: Float!
  searchId: String!
  exclude: Boolean!
  type: AttributeType
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RangeFilterInput.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Price from filter

#### [<code style={{ fontWeight: 'normal' }}>RangeFilterInput.<b>to</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Price to filter

#### [<code style={{ fontWeight: 'normal' }}>RangeFilterInput.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Range filter search identifier

#### [<code style={{ fontWeight: 'normal' }}>RangeFilterInput.<b>exclude</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Range filter exclude

#### [<code style={{ fontWeight: 'normal' }}>RangeFilterInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Range filter type

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## RegisterContactInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/register-contact-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input RegisterContactInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  homepage: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
  password: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the company the contact should be created in.

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the contact.

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Contacts's custom attribute values. This field is used to set value on attributes for the selected contact. Attributes that are used here (selected by name) must already be defined in Propeller.

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactInput.<b>password</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optionally create a prefilled password. When omitted the contact can set a new password using password reset(link)

### Member Of

[`contactRegister`](/reference/legacy/graphql-v1/mutations/contact-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterCustomerInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/register-customer-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input RegisterCustomerInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
  password: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the customer should be created in.

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the customer.

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Customer's custom attribute values. This field is used to set value on attributes for the selected customer. Attributes that are used here (selected by name) must already be defined in Propeller.

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerInput.<b>password</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optionally create a prefilled password. When omitted the customer can set a new password using password reset(link)

### Member Of

[`customerRegister`](/reference/legacy/graphql-v1/mutations/customer-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterUserInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/register-user-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input RegisterUserInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  email: String
  homepage: String
  taxNumber: String
  cocNumber: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  password: String
  createAccount: Boolean
  autoLogin: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the user should be created in.

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user.

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>password</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

optionally create a prefilled password. When omitted the user can set a new password using password reset(link)

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>createAccount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserInput.<b>autoLogin</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`userRegister`](/reference/legacy/graphql-v1/mutations/user-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## SearchByInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/search-by-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria for identifying a specific payment record.

Provides multiple ways to locate a payment using different identifier types. At least one search criterion must be provided. When multiple criteria are specified, they are combined with AND logic for precise matching.

```graphql
input SearchByInput {
  id: ID
  paymentId: String
  orderId: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SearchByInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Internal system payment identifier for direct record lookup.

Unique numeric identifier assigned by the system to identify the payment record. Most efficient search method when the internal ID is known.

#### [<code style={{ fontWeight: 'normal' }}>SearchByInput.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment service provider identifier for PSP correlation.

Unique payment reference provided by the Payment Service Provider for tracking and reconciliation. Maximum length of 255 characters. Used when correlating with external payment systems.

#### [<code style={{ fontWeight: 'normal' }}>SearchByInput.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order identifier for finding payments associated with specific orders.

Links payment records to their corresponding orders for order-payment relationship tracking. Used when searching for payments by order context.

### Member Of

[`payment`](/reference/legacy/graphql-v1/queries/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`paymentDelete`](/reference/legacy/graphql-v1/mutations/payment-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`paymentUpdate`](/reference/legacy/graphql-v1/mutations/payment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## SearchFieldsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/search-fields-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input SearchFieldsInput {
  fieldNames: [Searchablefields!]!
  boost: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SearchFieldsInput.<b>fieldNames</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Searchablefields!]!</b></code>](/reference/legacy/graphql-v1/enums/searchablefields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

List of available sortable fields

#### [<code style={{ fontWeight: 'normal' }}>SearchFieldsInput.<b>boost</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Search boost value

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## SearchSparePartsMachineInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/search-spare-parts-machine-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input SearchSparePartsMachineInput {
  page: Int!
  offset: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SearchSparePartsMachineInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SearchSparePartsMachineInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`machines`](/reference/legacy/graphql-v1/queries/machines.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## SharpenInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/sharpen-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sharpness of the output image.

The sharpen parameter increases the definition of the edges of objects in an image.

Notes

- The sharpen parameter is an implementation of an unsharp mask.

```graphql
input SharpenInput {
  amount: Float
  radius: Int
  threshold: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SharpenInput.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Sharpen amount value

#### [<code style={{ fontWeight: 'normal' }}>SharpenInput.<b>radius</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Sharpen radius value

#### [<code style={{ fontWeight: 'normal' }}>SharpenInput.<b>threshold</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Sharpen threshold value

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## SortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input SortInput {
  field: SortableFields!
  order: SortOrder
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortableFields!</b></code>](/reference/legacy/graphql-v1/enums/sortable-fields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Available sortable fields

#### [<code style={{ fontWeight: 'normal' }}>SortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort ordering ['desc' or 'asc']

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## SourceInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/source-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input SourceInput {
  id: String!
  name: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SourceInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Source ID

#### [<code style={{ fontWeight: 'normal' }}>SourceInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Name of the source

### Member Of

[`FavoriteListsCreateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsItemsInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsUpdateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Source

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/source

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input Source {
  id: String!
  name: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Source.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Source ID

#### [<code style={{ fontWeight: 'normal' }}>Source.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Name of the source

### Member Of

[`OrderlistCompaniesInput`](/reference/legacy/graphql-v1/inputs/orderlist-companies-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistCreateInput`](/reference/legacy/graphql-v1/inputs/orderlist-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistItemsInput`](/reference/legacy/graphql-v1/inputs/orderlist-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistSearchInput`](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistUpdateInput`](/reference/legacy/graphql-v1/inputs/orderlist-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistUsersInput`](/reference/legacy/graphql-v1/inputs/orderlist-users-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## StandardFileUploadInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/standard-file-upload-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

File upload from local filesystem using GraphQL multipart request specification

```graphql
input StandardFileUploadInput {
  file: Upload!
  fileName: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>StandardFileUploadInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Upload!</b></code>](/reference/legacy/graphql-v1/scalars/upload.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

File reference from local filesystem.

    Uses the GraphQL Upload form-data specification for multipart file uploads. The file is uploaded directly from the client's filesystem to the server for processing and storage.

#### [<code style={{ fontWeight: 'normal' }}>StandardFileUploadInput.<b>fileName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Custom filename for storing the uploaded file.

    If not provided, the original filename from the upload will be used. Must include the file extension and be between 5-255 characters. This name affects how the file is stored and referenced.

### Member Of

[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TaxSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tax-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TaxSearchInput {
  page: Int!
  offset: Int!
  zone: String
  shopId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TaxSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>TaxSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>TaxSearchInput.<b>zone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only search for taxes for zone

#### [<code style={{ fontWeight: 'normal' }}>TaxSearchInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Only search for taxes for shop

### Member Of

[`taxes`](/reference/legacy/graphql-v1/queries/taxes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## TenderAddItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-add-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderAddItemInput {
  quantity: Int!
  name: String
  price: Float
  supplier: String
  deliveryDate: DateTime
  notes: String
  productId: Int!
  childItems: [TenderChildItemInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Item quantity

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item name. Defaults to product name

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item price. Defaults to calculated sales price

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item supplier. Defaults to product supplier

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>deliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Delivery date

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes, remarks, etc.

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product ID

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemInput.<b>childItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderChildItemInput!]</b></code>](/reference/legacy/graphql-v1/inputs/tender-child-item-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Adds child items to this tender item. This field is used when adding configurable clusters to the Tender.
Provide an array of children options/ products of the parent item.

### Member Of

[`TenderAddItemsInput`](/reference/legacy/graphql-v1/inputs/tender-add-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TenderAddItemsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-add-items-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderAddItemsInput {
  tenderId: String!
  products: [TenderAddItemInput!]!
  forceAdd: Boolean
  validateOrderList: Boolean
  validateBudget: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemsInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemsInput.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderAddItemInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Tender items

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemsInput.<b>forceAdd</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

If set to true and an existing item for the same product is found, a new tender item will be created. Existing items are updated by default

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemsInput.<b>validateOrderList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

If set to false, the items will not be validated against customer order lists. Defaults to true

#### [<code style={{ fontWeight: 'normal' }}>TenderAddItemsInput.<b>validateBudget</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

If set to false, budget validation will be skipped. Defaults to true

### Member Of

[`tenderAddItems`](/reference/legacy/graphql-v1/mutations/tender-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderChildItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-child-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderChildItemInput {
  productId: Int!
  name: String
  price: Float
  deliveryDate: DateTime
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderChildItemInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product ID

#### [<code style={{ fontWeight: 'normal' }}>TenderChildItemInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item name. Defaults to product name

#### [<code style={{ fontWeight: 'normal' }}>TenderChildItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item price. Defaults to calculated sales price

#### [<code style={{ fontWeight: 'normal' }}>TenderChildItemInput.<b>deliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Delivery date

#### [<code style={{ fontWeight: 'normal' }}>TenderChildItemInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes, remarks, etc.

### Member Of

[`TenderAddItemInput`](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TenderDeleteItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-delete-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderDeleteItemInput {
  tenderId: String!
  itemId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderDeleteItemInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderDeleteItemInput.<b>itemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender item ID

### Member Of

[`tenderDeleteItem`](/reference/legacy/graphql-v1/mutations/tender-delete-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderDiscountInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-discount-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderDiscountInput {
  tenderId: String!
  type: DiscountType!
  value: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderDiscountInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderDiscountInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DiscountType!</b></code>](/reference/legacy/graphql-v1/enums/discount-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order discount type

#### [<code style={{ fontWeight: 'normal' }}>TenderDiscountInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount amount/ percentage, depending on discount type

### Member Of

[`tenderUpdateDiscount`](/reference/legacy/graphql-v1/mutations/tender-update-discount.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderPaymentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-payment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderPaymentInput {
  tenderId: String!
  amountGross: Float
  method: String
  status: String
  transactionId: String
  accountingId: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>amountGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected paymethod on this tender/order. VAT excluding. If omitted, payment costs are automatically calculated

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment status for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>transactionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment transaction ID for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymentInput.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Accounting ID for this tender/order

### Member Of

[`tenderUpdatePayment`](/reference/legacy/graphql-v1/mutations/tender-update-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderPostageInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-postage-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderPostageInput {
  tenderId: String!
  shippingMethod: String
  trackTrace: String
  requestDate: DateTime
  carrier: String
  postageGross: Float
  partialDeliveryAllowed: Boolean
  pickUpLocationId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>shippingMethod</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The shipping method for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>trackTrace</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Track & Trace code

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The carrier for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>postageGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shipping costs, VAT excluding. If omitted, shipping costs are automatically calculated

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

This order can be shipped in parts when items different delivery dates

#### [<code style={{ fontWeight: 'normal' }}>TenderPostageInput.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pick up location ID

### Member Of

[`tenderUpdatePostage`](/reference/legacy/graphql-v1/mutations/tender-update-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderStart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-start

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderStart {
  siteId: Int
  channelId: Int
  userId: Int!
  ownerId: Int
  type: TenderOrderType
  currency: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The site id for the tender created

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The channel id for the tender created

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The user ID for the tender created

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>ownerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the user editing the order. Defaults to userId

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderOrderType</b></code>](/reference/legacy/graphql-v1/enums/tender-order-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

The type for the tender created. Defaults to dropshipment

#### [<code style={{ fontWeight: 'normal' }}>TenderStart.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The currency for the tender created. Defaults to EUR

### Member Of

[`tenderStart`](/reference/legacy/graphql-v1/mutations/tender-start.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderUpdateAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-update-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderUpdateAddressInput {
  tenderId: String!
  type: TenderAddressType!
  company: String
  gender: Gender
  firstName: String
  middleName: String
  lastName: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  code: String
  email: String
  mobile: String
  phone: String
  fax: String
  url: String
  icp: YesNo
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderAddressType!</b></code>](/reference/legacy/graphql-v1/enums/tender-address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address company

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Address contact gender

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact first name

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact middle name

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact last name

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Street

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number extension

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Postal code

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

City

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Region

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Country code

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact email

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact mobile phone number

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact phone number

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>fax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact fax number

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact URL

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP is Yes when taxes do not apply for shipping to the given address/ country. Defaults to No

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateAddressInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes, remarks, etc.

### Member Of

[`tenderUpdateAddress`](/reference/legacy/graphql-v1/mutations/tender-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderUpdateInput {
  tenderId: String!
  status: String
  reference: String
  remarks: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Status of this tender

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateInput.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's reference for this tender

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateInput.<b>remarks</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's remarks for this tender

### Member Of

[`tenderUpdate`](/reference/legacy/graphql-v1/mutations/tender-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderUpdateItemInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/tender-update-item-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TenderUpdateItemInput {
  quantity: Int
  name: String
  price: Float
  supplier: String
  deliveryDate: DateTime
  notes: String
  tenderId: String!
  itemId: Int!
  validateOrderList: Boolean
  validateBudget: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item quantity

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item name. Defaults to product name

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item price. Defaults to calculated sales price

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Item supplier. Defaults to product supplier

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>deliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Delivery date

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes, remarks, etc.

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender unique ID

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>itemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender item ID

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>validateOrderList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

If set to false, the items will not be validated against customer order lists. Defaults to true

#### [<code style={{ fontWeight: 'normal' }}>TenderUpdateItemInput.<b>validateBudget</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

If set to false, budget validation will be skipped. Defaults to true

### Member Of

[`tenderUpdateItem`](/reference/legacy/graphql-v1/mutations/tender-update-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TextFilterInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/text-filter-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TextFilterInput {
  searchId: String!
  values: [String!]!
  exclude: Boolean!
  type: AttributeType
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TextFilterInput.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text filter search identifier

#### [<code style={{ fontWeight: 'normal' }}>TextFilterInput.<b>values</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text filter value

#### [<code style={{ fontWeight: 'normal' }}>TextFilterInput.<b>exclude</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text filter exclude

#### [<code style={{ fontWeight: 'normal' }}>TextFilterInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Text filter type

### Member Of

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## TransformationInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/transformation-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input TransformationInput {
  auto: Auto
  bgColor: String
  blur: Float
  brightness: Int
  canvas: CanvasInput
  contrast: Int
  crop: CropInput
  disable: FeaturesEnableDisable
  dpr: Int
  enable: FeaturesEnableDisable
  fit: Fit
  format: Format
  frame: Int
  height: Float
  level: Level
  metadata: ImageMetadata
  optimize: Optimize
  orient: Orient
  pad: PadInput
  precrop: CropInput
  profile: String
  quality: Float
  resizeFilter: ResizeFilter
  saturation: Int
  sharpen: SharpenInput
  trim: TrimInput
  width: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>auto</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Auto</b></code>](/reference/legacy/graphql-v1/enums/auto.mdx) <Badge class="badge badge--secondary " text="enum"/>

Enable optimization features automatically.

Enables optimizations based on content negotiation.

The only negotiated optimizations currently available are for AVIF and WebP, both image compression formats with limited browser support.

This functionality is also possible using format=auto which adds additional support for JPEGXL output.

Notes

- Although the AVIF and WebP formats produce images at a higher compression ratio with a lower loss of quality compared to JPEG, they are not supported in all browsers.
- When using Firefox version 66 to 71, automatic content negotiation will not occur when navigating to the image. To view WebP or AVIF images generated via auto=avif or auto=webp you must insert your image onto a web page.
- format=auto will take precedence if combined with auto.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>bgColor</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Set the background color of an image.

The bg-color parameter sets the background color of an image to use when applying padding or when replacing transparent pixels.

Its value may be one of:

- Hex RGB value: Both 3- and 6-digit values are acceptable (e.g. a22 or cf23a5).
- Decimal RGB: RGB values between 0 and 255. Comma-delimited (e.g. 255,0,0).
- Decimal RGB with alpha|RGBA colors include an additional value for alpha (transparency), which ranges from 0 for fully transparent to 1 for fully opaque.

Examples

- "c5c5c5" =&#x003E; Set background color to grey (Hex RGB)
- "000" =&#x003E; Set background color to black (Hex RGB)
- "255,0,0" =&#x003E; Set background color to red (Decimal RGB)
- "255,0,0,0.5" =&#x003E; Set background color to red with 50% transparency (Decimal RGBA)

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>blur</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Set the blurriness of the output image.

Applies a Gaussian blur filter to the image.

Its value is a number of pixels between 0.5 and 1000 or a percentage (of the dimensions of the image) suffixed with p (e.g., 1p for 1%).

Examples

- "50" =&#x003E; Apply a Gaussian blur with a radius of 50px
- "0.5p" =&#x003E; Apply a Gaussian blur with a radius of 0.5% of the image size

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>brightness</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Set the brightness of the output image.

The brightness parameter increases or decreases the amount of perceived light an image radiates or reflects.

Its value may be any number between -100 and 100.

Examples

- 50 =&#x003E; Increase the brightness by 50
- -42 =&#x003E; Decrease the brightness by 42

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>canvas</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CanvasInput</b></code>](/reference/legacy/graphql-v1/inputs/canvas-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Increase the size of the canvas around an image.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>contrast</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Set the contrast of the output image.

The contrast parameter increases or decreases the difference between the darkest and lightest tones in an image.

Notes

- The default value is 0. This leaves the image unchanged.
- A value of -100 will result in a fully grey image.

Examples

- 50 =&#x003E; Increase the contrast by 50

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>crop</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CropInput</b></code>](/reference/legacy/graphql-v1/inputs/crop-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Remove pixels from an image.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>disable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FeaturesEnableDisable</b></code>](/reference/legacy/graphql-v1/enums/features-enable-disable.mdx) <Badge class="badge badge--secondary " text="enum"/>

Disable functionality that is enabled by default.

upscale is already disabled by default. It can be enabled with the enable parameter.

Notes

- Image upscaling is discouraged because it increases both the file size and delivery time of the image to the end user with no visual improvement. We recommend handling upscaling on the client-side (e.g., using a web browser or native application).
- The upscale value must be used with the width, height, or dpr parameters to see any effect in the output image.

Examples

- "width=2560&disable=upscale" =&#x003E; Attempt to resize the image to 2560px wide but do not exceed the natural width of the source image

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>dpr</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Serve correctly sized images for devices that expose a device pixel ratio.

Device pixel ratio.

The dpr parameter provides a means to multiply image dimensions in order to translate logical pixels (also 'CSS pixels') into physical pixels. The device pixel ratio is therefore the ratio between physical pixels and logical pixels.

It is usually possible for client-side software to query the host system to determine the DPR of the display the user is viewing. In web browsers, this is available as the Window.devicePixelRatio variable in JavaScript. The iPhone 5 reports a device pixel ratio of 2, because the physical linear resolution is double the logical resolution.

- Physical Resolution: 960 x 640
- Logical Resolution: 480 x 320

Other devices report varying device pixel ratios, including non-integer ones. For example, the Nokia Lumia 1020 reports 1.6667, whereas the Samsung Galaxy S4 reports 3.

Its value may be any number between 1 and 10.

Examples

- width=200&dpr=2 =&#x003E; Resize the width to 400px (200 CSS pixels for screens with a device pixel ratio of 2)

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>enable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FeaturesEnableDisable</b></code>](/reference/legacy/graphql-v1/enums/features-enable-disable.mdx) <Badge class="badge badge--secondary " text="enum"/>

Enable functionality that is disabled by default.

Supported values:

- upscale =&#x003E; Allow images to be resized such that the output image's dimensions are larger than the source image.

Notes

- Image upscaling is discouraged because it increases both the file size and delivery time of the image to the end user with no visual improvement. We recommend handling upscaling on the client-side (e.g., using a web browser or native application).
- The upscale value must be used with the width, height, or dpr parameters to see any effect in the output image.

Examples:

- ?width=2560&enable=upscale =&#x003E; Resize the image to 2560px wide, even if the source image is smaller

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>fit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Fit</b></code>](/reference/legacy/graphql-v1/enums/fit.mdx) <Badge class="badge badge--secondary " text="enum"/>

Set how the image will fit within the size bounds provided.

The fit parameter controls how the image will be constrained within the provided size (width and height) values, in order to maintain the correct proportions.

Allowed values:

- bounds =&#x003E; Resize the image to fit entirely within the specified region, making one dimension smaller if needed.
- cover =&#x003E; Resize the image to entirely cover the specified region, making one dimension larger if needed.
- crop =&#x003E; Resize and crop the image centrally to exactly fit the specified region.

Notes
The fit parameter has no effect unless both width and height are specified.

Examples

- width=150&height=150&fit=bounds =&#x003E; Resize the image to fit within the bounds of 150px in width by 150px in height
- width=150&height=150&fit=cover =&#x003E; Resize the image to entirely cover 150px in width by 150px in height
- width=150&height=150&fit=crop =&#x003E; Crop the image to 150px in width by 150px in height

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>format</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Format</b></code>](/reference/legacy/graphql-v1/enums/format.mdx) <Badge class="badge badge--secondary " text="enum"/>

Specify the output format to convert the image to.

The format parameter enables the source image to be converted (a.k.a., "transcoded") from one encoded format to another. This is useful when the source image has been saved in a sub-optimal file format that hinders performance.

Notes

- The source image can be any of the following image formats: AVIF, JPEG, JPEGXL, PNG, GIF, WEBP.
- JPEG, progressive JPEG, WebP (Lossy), and PNG8 have a sliding quality scale that supports the quality parameter.
- GIF and PNG do not have a sliding quality scale. They do not support the quality parameter.
- A progressive JPEG pjpg is an image created using the JPEG suite of compression algorithms that will "fade in" successive waves of lines until the entire image has completely arrived. For this reason, progressive JPEG images typically appear to load quicker than the Baseline JPEG jpg format.
- WebP support is available in Google Chrome, Mozilla Firefox 65 and later, Safari 14 and later, Opera, and Android Browser.
- Lossless compression is currently supported for WebP and JPEGXL only.
- GIF to WebP conversion does not support animated GIFs.
- MP4 conversion is only available for animated GIF source images.
- AVIF and JPEGXL are premium features

About the auto value

The auto behavior aims to provide the optimal output format based on client capabilities as well as information related to the source image and transform characteristics. In that regard, we may adopt different heuristics to determine the output format for different source images or transforms.

When using format=auto, the image format delivered is always compatible with the current browser regardless of the source image format. This means a JPEGXL source image can safely be used in a browser where JPEGXL is not supported, and the resulting image is always viewable. With other format parameters and with auto=webp and auto=avif, there are some cases where the original format may be used.

- auto intelligently chooses the best format to deliver to the user prioritizing:
  - JPEGXL
  - AVIF
  - WebP
  - Source image format / JPEG

- Images default to lossy unless the quality parameter is set to 100.
- If no quality parameter is set, the default JPEG quality specified in IO default settings is used.
- Allows the use of JPEGXL, AVIF, or WebP as the source image format in cases where that image format is not support in the viewing environment.
- Quality mapping uses an SSIM similarity score between formats.
- Takes precedence if combined with the auto parameter.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>frame</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Extract the first frame from an animated image sequence.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>height</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Resize the height of the image.

The desired height of the output image.

The height parameter enables dynamic height resizing based on pixels and percent values.

The &#x007B;value&#x007D; can be either a positive integer or a positive number less than 1. If the value is an integer greater than or equal to 1, the value is interpreted as a pixel height. If the height parameter is less than 1, the value is interpreted as a percentage height.

Unless a width parameter is present, the height value will cause the width of the image to be scaled in proportion to the requested height. If both width and height are omitted, the input image dimensions are used.

value may be one of:

- Absolute height: An integer number of pixels.
- Relative height: A fraction between 0 and 0.99 (e.g., 0.5) or a percentage between 0 and 100 followed by the letter p (e.g., 50p). In either case, the value indicates the desired height relative to the image's natural height.

Notes

- The maximum output dimensions are 8,192 x 8,192 pixels.
- Because we use a positive number between 0 and 0.99 to return a percentage-based scaled image, in order to return an image that is 100% or more, a p suffix can be appended to the value. For example, height=250p would return an image that is 250% the height of the original. We use p as a simple way to represent percentages.
- If the requested height is not a whole number of pixels (e.g., as a result of applying a percentage value for height), it is rounded to the nearest integer.

Examples

- height=200 =&#x003E; Resize the height to 200px
- height=0.10 =&#x003E; Resize the height to 10% of the input image
- height=150p =&#x003E; Resize the height to 150% of the input image
- height=200&width=0.50 =&#x003E; Force resize to a height of 200px and a width that is 50% of the original
- height=200&dpr=2 =&#x003E; Resize the height to 400px (200 CSS pixels for screens with a device pixel ratio of 2)
- height=150&width=150&fit=bounds =&#x003E; Fit image within a 150 x 150px rectangle

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>level</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Level</b></code>](/reference/legacy/graphql-v1/enums/level.mdx) <Badge class="badge badge--secondary " text="enum"/>

Specify the level constraints when converting to video.

When converting animated GIFs to the MP4 format and when used in conjunction with the profile parameter, the level parameter specifies a set of constraints indicating a degree of required decoder performance for a profile.

Notes
If either level or profile parameters are missing, profile=baseline&level=3.0 will be used as the default.

Examples

- format=mp4&profile=main&level=5.2 =&#x003E; Convert the source animated GIF to MP4 format and select the main profile with a level of 5.2

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>metadata</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ImageMetadata</b></code>](/reference/legacy/graphql-v1/enums/image-metadata.mdx) <Badge class="badge badge--secondary " text="enum"/>

Include or exclude metadata from the output image.

By default, the image optimizer will remove all metadata embedded in an image. The metadata parameter allows this behavior to be configured.

Notes
This parameter is only effective when the source and destination format are both jpeg.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>optimize</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Optimize</b></code>](/reference/legacy/graphql-v1/enums/optimize.mdx) <Badge class="badge badge--secondary " text="enum"/>

Automatically apply optimal quality compression.

The optimize parameter automatically applies optimal quality compression to produce an output image with as much visual fidelity as possible, while minimizing the file size.

Notes

- Optimize is currently supported by the following output formats: JPEG, WebP, AVIF.
- If the quality parameter is also provided, quality overrides optimize because it is more precise.
- Because optimize attempts to produce an output image with as much visual quality as possible while minimizing the file size, the operations applied are subject to change.

Examples

- optimize=medium =&#x003E; Output an image with medium optimization
- optimize=high&auto=webp =&#x003E; Output a highly optimized JPEG. For browsers that support WebP output a highly optimized WebP image.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>orient</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Orient</b></code>](/reference/legacy/graphql-v1/enums/orient.mdx) <Badge class="badge badge--secondary " text="enum"/>

Change how the image will be orientated.

The orient parameter controls the cardinal orientation of the image.

Notes

- By default, if the source image contains orientation information stored within its metadata, that orientation will be applied to the image data and the orientation override removed from metadata.
- The numerical values are the same as EXIF rotation numbers.

Examples

- orient=r =&#x003E; Orient the image right
- orient=2 =&#x003E; Flip vertically
- orient=3 =&#x003E; Flip vertically and horizontally

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>pad</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PadInput</b></code>](/reference/legacy/graphql-v1/inputs/pad-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Add pixels to the edge of an image.

Notes

- By default padding applies a background color of white. See bg-color to change that.
- If the source image contains a transparent background and the output image also contains transparency, the padding will be made up of transparent pixels.
- When using pad and canvas at the same time, pad will be ignored.
- Values can be specified using CSS style shorthand values. (see CSS Margin or CSS Padding for more examples).
- CSS shorthand allows for all edges to be specified in one property.
- Any fractional pixel measurements will be rounded to the nearest whole pixel.

Examples

- pad=25,50,75,100 =&#x003E; Pad top edge 25px, right edge 50px, bottom edge 75px and left edge 100px
- pad=25,50,75 =&#x003E; Pad top edge 25px, right and left edge 50px, bottom edge 75px
- pad=25,50 =&#x003E; Pad top and bottom edge 25px, right and left edge 50px
- pad=0.25 =&#x003E; Pad all edges by 25%

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>precrop</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CropInput</b></code>](/reference/legacy/graphql-v1/inputs/crop-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Remove pixels from an image before any other transformations occur.

Identical to crop except that precrop is performed before any other transformations.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>profile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Specify the profile class of application when converting to video.

When converting animated GIFs to MP4 format and when used in conjunction with the level parameter, the profile parameter controls which features the video encoder can use based on a target class of application for decoding the specific video bitstream.

Notes
If either profile or level parameters are missing, profile=baseline&level=3.0 will be used as the default.

Examples

- format=mp4&profile=high&level=5.0 =&#x003E; Convert the source animated GIF to MP4 format and select the high profile with a level of 5.0

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>quality</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optimize the image to the given compression level for lossy file formatted images.

Output image quality for lossy file formats.

The quality parameter enables control over the compression level for lossy file-formatted images.

Its value may be any integer between 1 and 100, where 1 is a lower quality image and a smaller file and 100 is the highest quality image and larger file. If desired, a second quality level can be specified for use when auto=webp is enabled and a WebP output format has been selected.

Notes

- The quality parameter can be applied to the following output formats: avif, jpg, pjpg, png8, webp and webply.
- If no quality parameter is present for jpg, pjpg, or webp, the output image will be returned at the default value set in the Image Optimizer web interface.
- If auto=webp is enabled by the URL or the service settings, the second value will be used as the quality value if the requestor sends the accept: image/webp request header.
- When only specifying quality, if the output image file size is larger than the input image, the original image will be delivered.
- This does not include a way of specifying auto AVIF quality.

Examples

- quality=85 =&#x003E; Output an image with quality set to 85.
- format=pjpg&auto=webp&quality=85,75 =&#x003E; Convert the image format to a progressive jpg with image quality set to 85. For browsers that support WebP set the image quality to 75.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>resizeFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ResizeFilter</b></code>](/reference/legacy/graphql-v1/enums/resize-filter.mdx) <Badge class="badge badge--secondary " text="enum"/>

Specify the resize filter used when resizing images.

The resizeFilter parameter enables control over the resizing filter used to generate a new image with a higher or lower number of pixels.

Notes

- When making an image smaller, use bicubic, which has a natural sharpening effect.
- When making an image larger, use bilinear, which has a natural smoothing effect.
- When resizing pixel art, use nearest, which has a natural pixelation effect.
- When quality is the main concern, use lanczos, which typically renders the best results.

Examples

- resize-filter=bilinear Deliver an image that has been resized using the bilinear filter.

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>saturation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Set the saturation of the output image.

Saturation of the output image.

The saturation parameter increases or decreases the intensity of the colors in an image.

Its value may be any number between -100 and 100.

Notes

- The default value is 0. This leaves the image unchanged.
- Valid values range from -100 to 100
- A value of -100 will generate a grayscale image.

Examples

- saturation=25 =&#x003E; Increase saturation by 25
- saturation=-100 =&#x003E; Decrease saturation by 100 (rendering the image grayscale)

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>sharpen</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SharpenInput</b></code>](/reference/legacy/graphql-v1/inputs/sharpen-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Set the sharpness of the output image.

Sharpness of the output image.

The sharpen parameter increases the definition of the edges of objects in an image.

Notes
The sharpen parameter is an implementation of an unsharp mask.

Examples

- sharpen=a5,r2,t1 =&#x003E; Increase the sharpness of the image by amount:5, radius:2, and threshold:1

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>trim</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TrimInput</b></code>](/reference/legacy/graphql-v1/inputs/trim-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Remove pixels from the edge of an image.

The trim parameter removes pixels from the edge of an image by pixel or percentage value. This can be useful for removing whitespace and borders that appear on a source image.

Notes

- Values can be specified using CSS style shorthand values. (See CSS Margin or CSS Padding for more examples).
- CSS shorthand allows for all edges to be specified in one property.
- Any fractional pixel measurements will be rounded to the nearest whole pixel.

Examples

- trim=25,50,75,100 =&#x003E; Trim top edge 25px, right edge 50px, bottom edge 75px and left edge 100px
- trim=25,50,75 =&#x003E; Trim top edge 25px, right and left edge 50px, bottom edge 75px
- trim=25,50 =&#x003E; Trim top and bottom edge 25px, right and left edge 50px
- trim=0.25 =&#x003E; Trim all edges by 25%

#### [<code style={{ fontWeight: 'normal' }}>TransformationInput.<b>width</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Resize the width of the image.

    The desired width of the output image.

    The width parameter enables dynamic width resizing based on pixels and percent values.

    The &#x007B;value&#x007D; can be either a positive integer or a number less than 1. If the value is an integer greater than or equal to 1, the value is interpreted as a pixel width. If the width parameter is less than 1, the value is interpreted as a percentage width.

    Unless a height parameter is present, the width value will cause the height of the image to be scaled in proportion to the requested width. If both width and height are omitted, the input image dimensions are used.

    value may be one of:
    - Absolute width: An integer between 1 and 8192.
    - Relative width: A fraction between 0 and 0.99 (e.g. ,0.5) or a percentage between 0 and 100 followed by the letter p (e.g., 50p). In either case the value indicates the desired width relative to the image's natural width.

    Notes
    - The maximum output dimensions are 8,192 x 8,192 pixels.
    - If the image is animated, the maximum output dimensions apply to the sum of the area of all the frames of the image. For example, a 1024x1024px GIF could have 64 frames before it would exceed the size limit.
    - Because we use a positive number less than 1 to return a percentage-based scaled image, in order to return an image that is 100% or more, a p suffix can be appended to the value. For example, width=250p would return an image that is 250% the width of the original. We use p as a simple way to represent percent.
    - If the requested width is a fraction of a pixel (e.g., as a result of applying a percentage value for width), it is rounded to the nearest integer.

    Examples
    - width=200	                      =&#x003E; Resize the width to 200px
    - width=0.10	                    =&#x003E; Resize the width to 10% of the input image
    - width=150p	                    =&#x003E; Resize the width to 150% of the input image
    - width=200&height=0.50	          =&#x003E; Force resize to a width of 200px and a height that is 50% of the original.
    - width=150&height=150&fit=bounds	=&#x003E; Fit image within a 150 x 150px rectangle
    - width=200&dpr=2	                =&#x003E; Resize the width to 400px (200 CSS pixels for screens with a device pixel ratio of 2)

### Member Of

[`ImageTransformationInput`](/reference/legacy/graphql-v1/inputs/image-transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## TransformationsInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/transformations-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Container for multiple image transformation operations to be applied sequentially

```graphql
input TransformationsInput {
  transformations: [ImageTransformationInput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TransformationsInput.<b>transformations</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ImageTransformationInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/image-transformation-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

List of image transformations to apply.

    Transformations are applied in the order specified. Each transformation can include resizing, format conversion, quality adjustments, and various image effects. The output of one transformation becomes the input for the next.

---

## TrimInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/trim-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Remove pixels from the edge of an image.

The trim parameter removes pixels from the edge of an image by pixel or percentage value. This can be useful for removing whitespace and borders that appear on a source image.

Notes

- Values can be specified using CSS style shorthand values. (See CSS Margin or CSS Padding for more examples).
- CSS shorthand allows for all edges to be specified in one property.
- Any fractional pixel measurements will be rounded to the nearest whole pixel.

```graphql
input TrimInput {
  top: Int
  right: Int
  bottom: Int
  left: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TrimInput.<b>top</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Top - Pixels or Percentage(decimal 0.0 - 1) - Default=0

#### [<code style={{ fontWeight: 'normal' }}>TrimInput.<b>right</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Right - Pixels or Percentage(decimal 0.0 - 1) - Default=0

#### [<code style={{ fontWeight: 'normal' }}>TrimInput.<b>bottom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Bottom - Pixels or Percentage(decimal 0.0 - 1) - Default=0

#### [<code style={{ fontWeight: 'normal' }}>TrimInput.<b>left</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Left - Pixels or Percentage(decimal 0.0 - 1) - Default=0

### Member Of

[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UpdateBundleInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-bundle-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateBundleInput {
  name: String
  description: String
  discount: Float
  condition: BundleCondition
  price: Float
  taxZone: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The name for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The description for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage this bundle.

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>condition</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleCondition</b></code>](/reference/legacy/graphql-v1/enums/bundle-condition.mdx) <Badge class="badge badge--secondary " text="enum"/>

The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL).

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The bundle prices.

#### [<code style={{ fontWeight: 'normal' }}>UpdateBundleInput.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The bundle tax zone.

### Member Of

[`bundleUpdate`](/reference/legacy/graphql-v1/mutations/bundle-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateCategoryInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-category-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateCategoryInput {
  name: [LocalizedStringInput!]
  description: [LocalizedStringInput!]
  shortDescription: [LocalizedStringInput!]
  parent: Int
  defaultLanguage: String
  metadataTitle: [LocalizedStringInput!]
  metadataDescription: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrl: [LocalizedStringInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Localized category name as it is available in
the supported language defaults to the category's default language.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The long description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The long description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>parent</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The category's parent Category when available

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata title in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata description in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata keywords in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCategoryInput.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata canonical urls in different languages.

### Member Of

[`categoryUpdate`](/reference/legacy/graphql-v1/mutations/category-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateCompanyInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-company-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateCompanyInput {
  companyId: Int!
  name: String
  taxNumber: String
  cocNumber: String
  email: String
  phone: String
  notes: String
  parentId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the the company.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCompanyInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the company should be created in.

### Member Of

[`companyUpdate`](/reference/legacy/graphql-v1/mutations/company-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateContactInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-contact-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateContactInput {
  contactId: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  homepage: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the company the contact should be created in.

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the contact.

#### [<code style={{ fontWeight: 'normal' }}>UpdateContactInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Contacts's custom attribute values. This field is used to set value on attributes for the selected contact. Attributes that are used here (selected by name) must already be defined in Propeller.

### Member Of

[`contactUpdate`](/reference/legacy/graphql-v1/mutations/contact-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateCustomerInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-customer-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateCustomerInput {
  customerId: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  email: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
  attributes: [UserManagementAttributeValueInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the customer should be created in.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the customer.

#### [<code style={{ fontWeight: 'normal' }}>UpdateCustomerInput.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UserManagementAttributeValueInput!]</b></code>](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Customer's custom attribute values. This field is used to set value on attributes for the selected customer. Attributes that are used here (selected by name) must already be defined in Propeller.

### Member Of

[`customerUpdate`](/reference/legacy/graphql-v1/mutations/customer-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateInventoryInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-inventory-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateInventoryInput {
  quantity: Int
  notes: String
  nextDeliveryDate: String
  costPrice: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateInventoryInput.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory quantity

#### [<code style={{ fontWeight: 'normal' }}>UpdateInventoryInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory notes

#### [<code style={{ fontWeight: 'normal' }}>UpdateInventoryInput.<b>nextDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory estimated next delivery date in ISO8601 format

#### [<code style={{ fontWeight: 'normal' }}>UpdateInventoryInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory cost price

### Member Of

[`inventoryUpdate`](/reference/legacy/graphql-v1/mutations/inventory-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateMediaAttachmentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-media-attachment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateMediaAttachmentInput {
  alt: [MediaLocalizedStringInput!]
  description: [MediaLocalizedStringInput!]
  tags: [MediaLocalizedStringArrayInput!]
  priority: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaAttachmentInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaAttachmentInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaAttachmentInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaAttachmentInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

### Member Of

[`mediaAttachmentUpdate`](/reference/legacy/graphql-v1/mutations/media-attachment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateMediaDocumentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-media-document-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateMediaDocumentInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]
  description: [MediaLocalizedStringInput!]
  tags: [MediaLocalizedStringArrayInput!]
  priority: Int
  mediaId: String!
  uploadDocument: UploadFileInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MediaDocument unique identified

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaDocumentInput.<b>uploadDocument</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UploadFileInput</b></code>](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Upload File input reference

### Member Of

[`mediaDocumentUpdate`](/reference/legacy/graphql-v1/mutations/media-document-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateMediaImageInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-media-image-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input for updating an existing image media item with modified metadata or replacement file

```graphql
input UpdateMediaImageInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]
  description: [MediaLocalizedStringInput!]
  tags: [MediaLocalizedStringArrayInput!]
  priority: Int
  mediaId: String!
  uploadImage: UploadFileInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the image to update.

    Must be a valid media ID representing an existing image in the system. All updates will be applied to this specific image.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaImageInput.<b>uploadImage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UploadFileInput</b></code>](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Optional replacement image file.

    When provided, replaces the existing image file while preserving the metadata and associations. The new file will undergo the same processing and validation as during creation.

### Member Of

[`mediaImageUpdate`](/reference/legacy/graphql-v1/mutations/media-image-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateMediaVideoInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-media-video-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateMediaVideoInput {
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt: [MediaLocalizedStringInput!]
  description: [MediaLocalizedStringInput!]
  tags: [MediaLocalizedStringArrayInput!]
  priority: Int
  mediaId: String!
  video: UploadVideoInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for search indexing and user information. Each entry supports different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaLocalizedStringArrayInput!]</b></code>](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Searchable tags for categorizing and filtering media content.

    Keywords that help organize and discover media items. Used for search functionality and content organization. Each entry supports different languages with multiple tag values.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries and listings.

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MediaVideo unique identified

#### [<code style={{ fontWeight: 'normal' }}>UpdateMediaVideoInput.<b>video</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UploadVideoInput</b></code>](/reference/legacy/graphql-v1/inputs/upload-video-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Upload Video input reference

### Member Of

[`mediaVideoUpdate`](/reference/legacy/graphql-v1/mutations/media-video-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdatePaymentInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-payment-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Payment update data containing fields to be modified.

Extends the payment creation input with all fields made optional for partial updates. The order ID cannot be changed after payment creation. Only provided fields will be updated, others remain unchanged.

```graphql
input UpdatePaymentInput {
  userId: Int
  anonymousId: Int
  paymentId: String
  amount: Int
  currency: String
  method: String
  status: PaymentStatuses
  addTransaction: CreateTransactionInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Authenticated user identifier for payment attribution and history tracking.

Links the payment to a specific authenticated user for user-specific payment history and account management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>anonymousId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Anonymous user session identifier for guest checkout payments.

References the guest user session for payments made without authentication. Used for guest checkout tracking and order management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment identifier provided by the payment service provider for tracking.

Unique payment reference provided by the Payment Service Provider (PSP) for tracking and reconciliation. Used for payment status updates and transaction matching. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment amount in smallest currency unit (cents) for precise financial calculations.

The total amount to be paid expressed in the smallest denomination of the currency (e.g., cents for USD, pence for GBP). Must be a positive integer for precise financial calculations.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ISO 4217 three-letter currency code for international financial transactions.

Three-letter currency code (e.g., USD, EUR, GBP) following ISO 4217 standard. Used for currency conversion and financial reporting. Must be exactly 3 uppercase letters.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method code used by the payment service provider for transaction processing.

Specific payment method code used by the Payment Service Provider for processing this transaction (e.g., 'credit_card', 'paypal', 'bank_transfer'). Maximum length of 100 characters.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaymentStatuses</b></code>](/reference/legacy/graphql-v1/enums/payment-statuses.mdx) <Badge class="badge badge--secondary " text="enum"/>

Initial payment processing status for the new payment record.

Sets the starting status for the payment lifecycle. Determines the initial state and available actions for the payment processing workflow.

#### [<code style={{ fontWeight: 'normal' }}>UpdatePaymentInput.<b>addTransaction</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateTransactionInput</b></code>](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Optional transaction to create alongside the payment for immediate processing.

When provided, creates an associated transaction record with the payment for immediate processing and tracking. Enables atomic creation of payment and initial transaction in a single operation.

### Member Of

[`paymentUpdate`](/reference/legacy/graphql-v1/mutations/payment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateProductInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-product-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateProductInput {
  categoryId: Int
  name: [LocalizedStringInput!]
  description: [LocalizedStringInput!]
  shortDescription: [LocalizedStringInput!]
  sku: String
  status: ProductStatus
  supplier: String
  supplierCode: String
  manufacturerCode: String
  eanCode: String
  taxCode: TaxCode
  originalPrice: Float
  unit: Int
  minimumQuantity: Int
  manufacturer: String
  costPrice: Float
  suggestedPrice: Float
  package: String
  shortName: String
  packageDescription: [LocalizedStringInput!]
  notes: [LocalizedStringInput!]
  priority: Int
  metadataTitle: [LocalizedStringInput!]
  metadataDescription: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrl: [LocalizedStringInput!]
  productId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the category the product should be created in.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The names of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The short descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The sku of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductStatus</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="enum"/>

The status of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier code of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer (OEM) code of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The EAN code of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TaxCode</b></code>](/reference/legacy/graphql-v1/enums/tax-code.mdx) <Badge class="badge badge--secondary " text="enum"/>

The tax code of the product. Defaults to H.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original price of the product

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unit. Defaults to 1.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product minimum quantity. Defaults to 1.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer of the product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product cost price

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>suggestedPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product suggested price

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The default package type for this product.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>shortName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The short name product.
Commonly used for connections with third parties that
have a size limitation on the product name field.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>packageDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

The package type descriptions of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Notes of the product and it's translations in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata title in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata description in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata keywords in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

[SEO] Metadata canonical urls in different languages.

#### [<code style={{ fontWeight: 'normal' }}>UpdateProductInput.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the product.

### Member Of

[`productUpdate`](/reference/legacy/graphql-v1/mutations/product-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateTaxInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-tax-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateTaxInput {
  shopId: Int
  code: String
  zone: String!
  ratio: Float
  exportCode: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateTaxInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shop identifier for the tax to apply to... If not provided the default will be inferred from the channel

#### [<code style={{ fontWeight: 'normal' }}>UpdateTaxInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax code

#### [<code style={{ fontWeight: 'normal' }}>UpdateTaxInput.<b>zone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tax zone

#### [<code style={{ fontWeight: 'normal' }}>UpdateTaxInput.<b>ratio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax percentage expressed as ratio

#### [<code style={{ fontWeight: 'normal' }}>UpdateTaxInput.<b>exportCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax export code

### Member Of

[`taxUpdate`](/reference/legacy/graphql-v1/mutations/tax-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateUserInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-user-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateUserInput {
  userId: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  email: String
  homepage: String
  taxNumber: String
  cocNumber: String
  phone: String
  mobile: String
  dateOfBirth: String
  mailingList: YesNo
  parentId: Int
  primaryLanguage: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>homepage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the user should be created in.

#### [<code style={{ fontWeight: 'normal' }}>UpdateUserInput.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user.

### Member Of

[`userUpdate`](/reference/legacy/graphql-v1/mutations/user-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateUsergroupInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-usergroup-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateUsergroupInput {
  usergroupId: Int!
  name: String
  parentId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateUsergroupInput.<b>usergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the the usergroup.

#### [<code style={{ fontWeight: 'normal' }}>UpdateUsergroupInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UpdateUsergroupInput.<b>parentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup the company should be created in.

### Member Of

[`usergroupUpdate`](/reference/legacy/graphql-v1/mutations/usergroup-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateWarehouseAddressInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-warehouse-address-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateWarehouseAddressInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseAddressInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`warehouseAddressUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UpdateWarehouseInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/update-warehouse-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpdateWarehouseInput {
  name: String
  description: String
  notes: String
  isActive: Boolean
  isStore: Boolean
  isPickupLocation: Boolean
  shopId: Int
  businessHours: [BusinessHoursInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse name

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse description

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse notes

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>isActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isActive status

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>isStore</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isStore status

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>isPickupLocation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isPickupLocation status

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optional warehouse shopId! Default value will be internally inferred from the appropriate channel

#### [<code style={{ fontWeight: 'normal' }}>UpdateWarehouseInput.<b>businessHours</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessHoursInput!]</b></code>](/reference/legacy/graphql-v1/inputs/business-hours-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Warehouse business hours per week day

    Example:
        [&#x007B;
          dayOfWeek: 0
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 1
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 2
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 3
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 4
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 5
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;,
        &#x007B;
          dayOfWeek: 6
          openingTime: "08:00"
          closingTime: "20:00"
          lunchBeakStartTime: "12:00"
          lunchBeakEndTime: "12:30"
        &#x007D;]

### Member Of

[`warehouseUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UploadFileInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/upload-file-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Flexible file upload input supporting multiple upload methods and configurations

```graphql
input UploadFileInput {
  language: String
  uploadType: UploadType!
  cacheControl: CacheControlInput
  base64File: MediaBase64FileInput
  file: StandardFileUploadInput
  urlFile: UrlFileUploadInput
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language code for the uploaded file content.

    Specifies the language context for the file, used for localization and content organization. Must be a valid 2-character language code (e.g., 'EN', 'DE', 'FR').

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>uploadType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UploadType!</b></code>](/reference/legacy/graphql-v1/enums/upload-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Method of file upload to use.

    Determines whether the file should be stored internally or referenced externally. Affects how the file is processed, stored, and accessed.

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>cacheControl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CacheControlInput</b></code>](/reference/legacy/graphql-v1/inputs/cache-control-input.mdx) <Badge class="badge badge--secondary " text="input"/>

HTTP cache control settings for the uploaded file.

    Controls how browsers and CDNs cache the file content. Optional configuration that defaults to optimal caching settings if not specified.

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>base64File</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaBase64FileInput</b></code>](/reference/legacy/graphql-v1/inputs/media-base-64-file-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Base64 encoded file upload option.

    Use this method when uploading files as base64 encoded strings. Suitable for small files or when direct file upload is not available. Maximum size is approximately 10MB.

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>StandardFileUploadInput</b></code>](/reference/legacy/graphql-v1/inputs/standard-file-upload-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Direct file upload from filesystem.

    Use this method for uploading files directly from the client's filesystem using GraphQL multipart request specification. Most efficient for larger files.

#### [<code style={{ fontWeight: 'normal' }}>UploadFileInput.<b>urlFile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UrlFileUploadInput</b></code>](/reference/legacy/graphql-v1/inputs/url-file-upload-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Upload file from a publicly accessible URL.

    Use this method to upload files by providing a URL. The system will download the file from the specified location and store it locally.

### Member Of

[`MediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentInput`](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageInput`](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UploadVideoInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/upload-video-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Video upload specification with language and location information

```graphql
input UploadVideoInput {
  language: String
  uri: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UploadVideoInput.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language code for the video content.

    Specifies the language context for the video, used for localization and content organization. Must be a valid 2-character language code (e.g., 'EN', 'DE', 'FR').

#### [<code style={{ fontWeight: 'normal' }}>UploadVideoInput.<b>uri</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

URL or URI pointing to the video content.

    Can be a direct link to a video file, or a URL from supported video platforms like YouTube or Vimeo. The URL must be publicly accessible and return valid video content.

### Member Of

[`MediaVideoInput`](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UpsertSparePartsMachineInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UpsertSparePartsMachineInput {
  externalReference: ExternalReferenceInput!
  name: [LocalizedStringInput!]!
  description: [LocalizedStringInput!]
  machines: [CreateSparePartsMachineInput!]
  parts: [CreateSparePartInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UpsertSparePartsMachineInput.<b>externalReference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExternalReferenceInput!</b></code>](/reference/legacy/graphql-v1/inputs/external-reference-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>UpsertSparePartsMachineInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Spare PartsMachine name

#### [<code style={{ fontWeight: 'normal' }}>UpsertSparePartsMachineInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Machine description

#### [<code style={{ fontWeight: 'normal' }}>UpsertSparePartsMachineInput.<b>machines</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CreateSparePartsMachineInput!]</b></code>](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Level 1 SubMachines input

#### [<code style={{ fontWeight: 'normal' }}>UpsertSparePartsMachineInput.<b>parts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CreateSparePartInput!]</b></code>](/reference/legacy/graphql-v1/inputs/create-spare-part-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Spare parts for this machine

### Member Of

[`machineUpsert`](/reference/legacy/graphql-v1/mutations/machine-upsert.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UrlFileUploadInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/url-file-upload-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Upload media content by providing a publicly accessible URL

```graphql
input UrlFileUploadInput {
  url: String!
  fileName: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UrlFileUploadInput.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Publicly accessible URL to the media file.

    The URL must be accessible without authentication and return the actual file content. The service will download and store the file from this location.

#### [<code style={{ fontWeight: 'normal' }}>UrlFileUploadInput.<b>fileName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Filename to use when storing the downloaded file.

    Must include the file extension and be between 5-255 characters. This name will be used for storage and may affect how the file is processed.

### Member Of

[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UserAddressCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/user-address-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UserAddressCreateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  userId: Int!
  type: AddressType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address user primary identifier

#### [<code style={{ fontWeight: 'normal' }}>UserAddressCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType!</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type [one of 'home', 'delivery' or 'invoice']

### Member Of

[`userAddressCreate`](/reference/legacy/graphql-v1/mutations/user-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UserAddressDeleteInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/user-address-delete-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UserAddressDeleteInput {
  id: Int!
  userId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserAddressDeleteInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>UserAddressDeleteInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User primary identifier

### Member Of

[`userAddressDelete`](/reference/legacy/graphql-v1/mutations/user-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UserAddressUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/user-address-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UserAddressUpdateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String
  number: String
  numberExtension: String
  postalCode: String
  city: String
  region: String
  country: String
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  userId: Int!
  id: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User first name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

User gender the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street address

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User street number extension

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address fixed phone number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address mobile number [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address email [valid email format required]

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address user primary identifier

#### [<code style={{ fontWeight: 'normal' }}>UserAddressUpdateInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

### Member Of

[`userAddressUpdate`](/reference/legacy/graphql-v1/mutations/user-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## UserManagementAttributeSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UserManagementAttributeSearchInput {
  type: AttributeType!
  name: String!
  textValue: LocalizedStringArrayInput
  enumValue: [String!]
  intValue: Int
  decimalValue: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Attribute type.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Attribute name for which the value is applied for.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>textValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>LocalizedStringArrayInput</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Textual value(s) for the attribute, required when attribute type equals text, list or color. This value is suitable for Localization.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>enumValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Enumeration value for the attribute, required when type equals enum or enumlist. Values in this field can be multivalue.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>intValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Integer value for the attribute, required when attribute type equals numeric or object.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeSearchInput.<b>decimalValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Decimal value for the attribute, required when attribute type equals decimal.

### Member Of

[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UserManagementAttributeValueInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UserManagementAttributeValueInput {
  type: AttributeType!
  name: String!
  textValue: LocalizedStringArrayInput
  enumValue: [String!]
  intValue: Int
  decimalValue: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Attribute type.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Attribute name for which the value is applied for.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>textValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>LocalizedStringArrayInput</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-array-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Textual value(s) for the attribute, required when attribute type equals text, list or color. This value is suitable for Localization.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>enumValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Enumeration value for the attribute, required when type equals enum or enumlist. Values in this field can be multivalue.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>intValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Integer value for the attribute, required when attribute type equals numeric or object.

#### [<code style={{ fontWeight: 'normal' }}>UserManagementAttributeValueInput.<b>decimalValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Decimal value for the attribute, required when attribute type equals decimal.

### Member Of

[`CreateContactInput`](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerInput`](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterContactInput`](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterCustomerInput`](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateContactInput`](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCustomerInput`](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## UsergroupSearchArguments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/usergroup-search-arguments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UsergroupSearchArguments {
  name: String
  page: Int
  offset: Int
  sort: [UsergroupSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSearchArguments.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Usergroup's name

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSearchArguments.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSearchArguments.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSearchArguments.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[UsergroupSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/usergroup-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of usergroup sort filters

### Member Of

[`usergroups`](/reference/legacy/graphql-v1/queries/usergroups.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## UsergroupSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/usergroup-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input UsergroupSortInput {
  field: UsergroupSortableFields!
  order: SortOrder!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UsergroupSortableFields!</b></code>](/reference/legacy/graphql-v1/enums/usergroup-sortable-fields.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Available sortable fields

#### [<code style={{ fontWeight: 'normal' }}>UsergroupSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SortOrder!</b></code>](/reference/legacy/graphql-v1/enums/sort-order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Sort ordering ['desc' or 'asc']

### Member Of

[`UsergroupSearchArguments`](/reference/legacy/graphql-v1/inputs/usergroup-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ValuesetCreateInput {
  name: String!
  descriptions: [LocalizedStringInput!]
  type: ValuesetType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetCreateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier name for the new value set that will be used throughout the system for referencing and configuration purposes.

Must be unique across all value sets and follow naming conventions for system identifiers.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetCreateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Human-readable descriptions explaining the purpose and usage of this value set in multiple languages.

Provides context for administrators and developers about what this value set represents and how it should be used throughout the system.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetCreateInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetType!</b></code>](/reference/legacy/graphql-v1/enums/valueset-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Classification determining the management scope and modification permissions for this value set.

SYSTEM types are reserved for core system functionality and can only be created by automated processes. CUSTOM types can be created and modified by authorized users for business-specific needs.

### Member Of

[`valuesetCreate`](/reference/legacy/graphql-v1/mutations/valueset-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ValuesetItemCreateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-item-create-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ValuesetItemCreateInput {
  valuesetId: Int!
  value: String!
  descriptions: [LocalizedStringInput!]
  extra: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemCreateInput.<b>valuesetId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the parent value set that will contain this new item.

Must reference an existing value set that the user has permission to modify.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemCreateInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The actual data value that this item will represent in the system.

Must be unique within the parent value set and will be used as the key for selection and processing. Length must be between 1 and 512 characters.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemCreateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Human-readable labels for this value set item in multiple languages.

These descriptions will be displayed to users in dropdown lists, selection interfaces, and other UI components. Providing multiple languages ensures proper internationalization support.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemCreateInput.<b>extra</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional metadata or supplementary information for this value set item.

Can be used to store related data such as currency codes, country codes, or other contextual information that enhances the item's functionality. Maximum length is 512 characters.

### Member Of

[`valuesetItemCreate`](/reference/legacy/graphql-v1/mutations/valueset-item-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ValuesetItemSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-item-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search criteria and pagination parameters for filtering value set items across multiple value sets

```graphql
input ValuesetItemSearchInput {
  page: Int
  offset: Int
  ids: [Int!]
  valuesetIds: [Int!]
  values: [String!]
  extras: [String!]
  sortInputs: [ValuesetItemSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination, starting from 1. Used to navigate through multiple pages of results when the total number of items exceeds the offset limit. Must be a positive integer (minimum: 1).

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of value set items to return per page. Controls the size of each page in the paginated response to manage data volume and performance. Must be between 1 and 100 items per page.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific value set item identifiers. Provide an array of numeric IDs to retrieve only those specific items, useful for bulk operations or targeted queries.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>valuesetIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter items by their parent value set identifiers. Provide an array of value set IDs to retrieve items from specific value sets only, essential for dropdown population.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>values</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter items by their actual data values. Provide an array of value strings to find items with matching values, helpful for searching specific options in dropdown lists.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>extras</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter items by their extra metadata values. Provide an array of extra value strings to find items with matching additional data like codes or categories.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSearchInput.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ValuesetItemSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/valueset-item-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Sorting criteria for organizing search results. Supports multiple sort fields with different orders to achieve complex result organization for dropdown displays.

### Member Of

[`valuesetItems`](/reference/legacy/graphql-v1/queries/valueset-items.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ValuesetItemSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-item-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sorting configuration for value set item search results, allowing organization by various fields and sort orders for optimal dropdown display

```graphql
input ValuesetItemSortInput {
  field: ValuesetItemSortField!
  order: ValuesetSortOrder
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemSortField!</b></code>](/reference/legacy/graphql-v1/enums/valueset-item-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The field to sort value set items by. Choose from ID, VALUE, or EXTRA to organize results according to your specific display needs and user experience requirements.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetSortOrder</b></code>](/reference/legacy/graphql-v1/enums/valueset-sort-order.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order direction. Use ASC for ascending order (A-Z, 1-9) or DESC for descending order (Z-A, 9-1) to match user interface expectations.

### Member Of

[`ValuesetItemSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-item-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetItemUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-item-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Partial update data for modifying existing value set item properties. All fields are optional - only provided fields will be updated while others remain unchanged. The parent value set association cannot be changed after creation for data integrity reasons.

```graphql
input ValuesetItemUpdateInput {
  value: String
  descriptions: [LocalizedStringInput!]
  extra: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemUpdateInput.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The actual data value that this item will represent in the system.

Must be unique within the parent value set and will be used as the key for selection and processing. Length must be between 1 and 512 characters.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemUpdateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Human-readable labels for this value set item in multiple languages.

These descriptions will be displayed to users in dropdown lists, selection interfaces, and other UI components. Providing multiple languages ensures proper internationalization support.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemUpdateInput.<b>extra</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional metadata or supplementary information for this value set item.

Can be used to store related data such as currency codes, country codes, or other contextual information that enhances the item's functionality. Maximum length is 512 characters.

### Member Of

[`valuesetItemUpdate`](/reference/legacy/graphql-v1/mutations/valueset-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ValuesetSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input ValuesetSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  ids: [Int!]
  names: [String!]
  type: ValuesetType
  sortInputs: [ValuesetSortInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Page number for pagination, starting from 1. Used to navigate through multiple pages of results when the total number of value sets exceeds the offset limit. Must be a positive integer (minimum: 1).

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number of value sets to return per page. Controls the size of each page in the paginated response to manage data volume and performance. Must be between 1 and 100 items per page.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter value sets by their creation date range. Useful for finding recently created value sets or tracking configuration changes over time.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Filter value sets by their last modification date range. Helpful for identifying recently updated configurations or tracking maintenance activities.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific value set identifiers. Provide an array of numeric IDs to retrieve only those specific value sets, useful for bulk operations or targeted queries.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>names</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Filter by specific value set names. Provide an array of name strings to retrieve value sets with matching names, helpful for configuration management and system integration.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetType</b></code>](/reference/legacy/graphql-v1/enums/valueset-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

Filter by value set type classification. SYSTEM types are managed automatically by the system, while CUSTOM types can be modified by authorized users.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSearchInput.<b>sortInputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ValuesetSortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/valueset-sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Sorting criteria for organizing search results. Supports multiple sort fields with different orders to achieve complex result organization.

### Member Of

[`valuesets`](/reference/legacy/graphql-v1/queries/valuesets.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ValuesetSortInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-sort-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Sorting configuration for value set search results, allowing organization by various fields and sort orders

```graphql
input ValuesetSortInput {
  field: ValuesetSortField!
  order: ValuesetSortOrder
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortInput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetSortField!</b></code>](/reference/legacy/graphql-v1/enums/valueset-sort-field.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The field to sort value sets by. Choose from ID, NAME, CREATED_AT, or LAST_MODIFIED_AT to organize results according to your specific needs.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetSortInput.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetSortOrder</b></code>](/reference/legacy/graphql-v1/enums/valueset-sort-order.mdx) <Badge class="badge badge--secondary " text="enum"/>

Sort order direction. Use ASC for ascending order (A-Z, 1-9, oldest first) or DESC for descending order (Z-A, 9-1, newest first).

### Member Of

[`ValuesetSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## ValuesetUpdateInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/valueset-update-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Partial update data for modifying existing value set properties. All fields are optional - only provided fields will be updated while others remain unchanged. The type field cannot be modified after creation for data integrity reasons.

```graphql
input ValuesetUpdateInput {
  name: String
  descriptions: [LocalizedStringInput!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetUpdateInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier name for the new value set that will be used throughout the system for referencing and configuration purposes.

Must be unique across all value sets and follow naming conventions for system identifiers.

#### [<code style={{ fontWeight: 'normal' }}>ValuesetUpdateInput.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringInput!]</b></code>](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Human-readable descriptions explaining the purpose and usage of this value set in multiple languages.

Provides context for administrators and developers about what this value set represents and how it should be used throughout the system.

### Member Of

[`valuesetUpdate`](/reference/legacy/graphql-v1/mutations/valueset-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## VerifyTokenInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/verify-token-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input VerifyTokenInput {
  token: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>VerifyTokenInput.<b>token</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`verifyToken`](/reference/legacy/graphql-v1/mutations/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## VideoCsvInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/video-csv-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input VideoCsvInput {
  file: Upload!
  mappings: [VideoCsvMapping!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>VideoCsvInput.<b>file</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Upload!</b></code>](/reference/legacy/graphql-v1/scalars/upload.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

CSV file

#### [<code style={{ fontWeight: 'normal' }}>VideoCsvInput.<b>mappings</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[VideoCsvMapping!]</b></code>](/reference/legacy/graphql-v1/inputs/video-csv-mapping.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

A list of MediaVideos CSV field mappings

### Member Of

[`mediaVideoCsvImport`](/reference/legacy/graphql-v1/mutations/media-video-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## VideoCsvMapping

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/video-csv-mapping

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input VideoCsvMapping {
  csvHeader: String!
  fieldName: VideoFieldName!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>VideoCsvMapping.<b>csvHeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the column in the CSV file

#### [<code style={{ fontWeight: 'normal' }}>VideoCsvMapping.<b>fieldName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>VideoFieldName!</b></code>](/reference/legacy/graphql-v1/enums/video-field-name.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The name of the field in Propeller eCommerce Platform

### Member Of

[`VideoCsvInput`](/reference/legacy/graphql-v1/inputs/video-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## WarehousesSearchInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/inputs/warehouses-search-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
input WarehousesSearchInput {
  ids: [Int!]
  isActive: Boolean
  isStore: Boolean
  isPickupLocation: Boolean
  page: Int
  offset: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>ids</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Search warehouses by ids

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>isActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isActive status

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>isStore</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isStore status

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>isPickupLocation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isPickupLocation status

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>WarehousesSearchInput.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`warehouses`](/reference/legacy/graphql-v1/queries/warehouses.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## IAttributeDecimalRangeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iattribute-decimal-range-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IAttributeDecimalRangeFilter {
  min: Float!
  max: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IAttributeDecimalRangeFilter.<b>min</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Minumum value for this attribute

#### [<code style={{ fontWeight: 'normal' }}>IAttributeDecimalRangeFilter.<b>max</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value.

### Implemented By

[`AttributeDecimalRangeFilter`](/reference/legacy/graphql-v1/objects/attribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IAttributeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iattribute-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IAttributeFilter {
  id: String!
  searchId: String!
  description: String!
  type: AttributeType!
  isSearchable: Boolean!
  isPublic: Boolean!
  isHidden: Boolean
  textFilter: [AttributeTextFilter!]
  integerRangeFilter: AttributeIntegerRangeFilter
  decimalRangeFilter: AttributeDecimalRangeFilter
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Atribute as it's defined in the Database

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Lowercased representation of the id with an attr\_ prefix that can be
used in query parameters.
The attr\_ prefix is to avoid potential naming conflict with regular
product fields

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The human readable description of the attribute's name.
This is a language specific value.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the attribute.
Possible values: - text - list - enum - enumlist - color - date - datetime - object - integer - decimal

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
catalog page filters.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
product specs.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute us hidden and should
only be used for background operations.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>textFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeTextFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

All available attribute text values within this search result for this particulat attribute.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>integerRangeFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeIntegerRangeFilter</b></code>](/reference/legacy/graphql-v1/objects/attribute-integer-range-filter.mdx) <Badge class="badge badge--secondary " text="object"/>

Minumum and maximum value range for integer attributes

#### [<code style={{ fontWeight: 'normal' }}>IAttributeFilter.<b>decimalRangeFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeDecimalRangeFilter</b></code>](/reference/legacy/graphql-v1/objects/attribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary " text="object"/>

Minumum and maximum value range for decimal attributes

### Implemented By

[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IAttributeIntegerRangeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iattribute-integer-range-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IAttributeIntegerRangeFilter {
  min: Int!
  max: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IAttributeIntegerRangeFilter.<b>min</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Minumum value for this attribute

#### [<code style={{ fontWeight: 'normal' }}>IAttributeIntegerRangeFilter.<b>max</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value.

### Implemented By

[`AttributeIntegerRangeFilter`](/reference/legacy/graphql-v1/objects/attribute-integer-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IAttributeTextFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iattribute-text-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IAttributeTextFilter {
  value: String!
  count: Int!
  countTotal: Int
  countActive: Int
  isSelected: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IAttributeTextFilter.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The value of the attribute

#### [<code style={{ fontWeight: 'normal' }}>IAttributeTextFilter.<b>count</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value with all attributes applied.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeTextFilter.<b>countTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value without any attribute filters applied.

#### [<code style={{ fontWeight: 'normal' }}>IAttributeTextFilter.<b>countActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value without all attributes except it's own applied.
This can be used to display the active filter's totals

#### [<code style={{ fontWeight: 'normal' }}>IAttributeTextFilter.<b>isSelected</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whehter this values is currently selected

### Implemented By

[`AttributeTextFilter`](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBaseProduct

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibase-product

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Interface for the BaseProduct Type, where both Products and
clusters derive from

```graphql
interface IBaseProduct {
  id: Int!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]!
  slug(language: String): [LocalizedString!]!
  sku: String!
  categoryId: Int!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized product name as it is available in
the supported language defaults to the product's default language.

##### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The long description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The short description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Slugified version of the product name, that can be used in urls.
A slug is available per language.

##### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Stock keeping unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default language for this product or cluster,
this is the language to fall back too, when there is no translation avaialbe in a specific language.

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>sources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductSource!]!</b></code>](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

#### [<code style={{ fontWeight: 'normal' }}>IBaseProduct.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Path is no longer supported



The catalog path of this product.
Contains a list of ID's of categories with a / as delimiter

</Details>

### Member Of

[`Crossupsell`](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductsResponse`](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePart`](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

### Implemented By

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBaseUser

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibase-user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Interface for the BaseUser Type, where both Contacts and Customers derive from

```graphql
interface IBaseUser {
  id: Int! @deprecated
  debtorId: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  phone: String
  mobile: String
  email: String!
  iban: String
  bankAccount: String
  bic: String
  notes: String
  primaryLanguage: String
  expires: DateTime
  externalId: String
  dateOfBirth: DateTime
  mailingList: YesNo
  isLoggedIn: Boolean
  dateCreated: DateTime
  lastModifiedDate: DateTime
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

The gender of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The first name of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The middle name of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The last name of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The phone number of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The mobile number of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email of the user.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>iban</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The International Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>bankAccount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>bic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Identification Code of the user

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>expires</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expiration date of the contact. After this date expires contact will be disabled.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External ID

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date of birth of the contact.

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>isLoggedIn</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>IBaseUser.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use userId instead.



The unique identifier of the user.

</Details>

### Returned By

[`user`](/reference/legacy/graphql-v1/queries/user.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userCreate`](/reference/legacy/graphql-v1/mutations/user-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userUpdate`](/reference/legacy/graphql-v1/mutations/user-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`viewer`](/reference/legacy/graphql-v1/queries/viewer.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterContactResponse`](/reference/legacy/graphql-v1/objects/register-contact-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterCustomerResponse`](/reference/legacy/graphql-v1/objects/register-customer-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterUserResponse`](/reference/legacy/graphql-v1/objects/register-user-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

### Implemented By

[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBundleItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibundle-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IBundleItem {
  productId: Int!
  price: BundlePrice
  isLeader: YesNo!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBundleItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The bundles primary product identifier

#### [<code style={{ fontWeight: 'normal' }}>IBundleItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundlePrice</b></code>](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary " text="object"/>

Bundle price.

#### [<code style={{ fontWeight: 'normal' }}>IBundleItem.<b>isLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the product is leader for this bundle.

### Implemented By

[`BundleItem`](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBundlePrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibundle-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IBundlePrice {
  net: Float
  gross: Float
  originalNet: Float
  originalGross: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBundlePrice.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Net price of the bundle after discounts applied

#### [<code style={{ fontWeight: 'normal' }}>IBundlePrice.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Gross price of the bundle after discounts applied

#### [<code style={{ fontWeight: 'normal' }}>IBundlePrice.<b>originalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original net price of the bundle before discounts applied

#### [<code style={{ fontWeight: 'normal' }}>IBundlePrice.<b>originalGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original gross price of the bundle before discounts applied

### Implemented By

[`BundlePrice`](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBundle

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibundle

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IBundle {
  id: Float!
  comboId: Float @deprecated
  name: String!
  description: String
  discount: Float
  condition: BundleCondition
  price: BundlePrice
  items: [BundleItem!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The bundles primary identifier

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The description for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage this bundle.

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>condition</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleCondition</b></code>](/reference/legacy/graphql-v1/enums/bundle-condition.mdx) <Badge class="badge badge--secondary " text="enum"/>

The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL).

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundlePrice</b></code>](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary " text="object"/>

The bundle prices.

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BundleItem!]</b></code>](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Items for this bundle.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>IBundle.<b>comboId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



The comboId is deprecated and will be removed in the future. Please use the id field instead.



[DEPRECATED] The bundles identifier for Propeller internal use

</Details>

### Implemented By

[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBusinessRuleExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

```graphql
interface IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

### Member Of

[`BusinessRuleExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleSubExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

### Implemented By

[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpression`](/reference/legacy/graphql-v1/objects/business-rule-string-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IBusinessRuleNode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Base interface for all business rule node types defining common properties and behavior.

Nodes are the fundamental processing units within a business rule graph, each serving a specific function:

- Input nodes receive and validate incoming data
- Decision table nodes contain the core business logic and rules
- Output nodes format and return the final results
- Function nodes execute custom computational logic

```graphql
interface IBusinessRuleNode {
  type: BusinessRuleNodeType!
  id: ID!
  name: String!
  description: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleNode.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNodeType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-node-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Functional classification of the node determining its role in the business rule execution flow

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleNode.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for the node within the business rule graph

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleNode.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Human-readable name of the node for identification and documentation purposes

#### [<code style={{ fontWeight: 'normal' }}>IBusinessRuleNode.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Detailed explanation of the node's purpose and functionality within the business rule workflow

### Member Of

[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

### Implemented By

[`BusinessRuleDecisionTable`](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleInput`](/reference/legacy/graphql-v1/objects/business-rule-input.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleOutput`](/reference/legacy/graphql-v1/objects/business-rule-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ICartBaseItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/icart-base-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface ICartBaseItem {
  id: Int!
  notes: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  sum: Float!
  sumNet: Float!
  totalSum: Float!
  totalSumNet: Float!
  quantity: Int!
  bundleId: Int
  productId: Int
  taxCode: Taxcode!
  expectedDeliveryDate: DateTime
  deliveryDeadline: DateTime
  discount: Float!
  discountPercentage: Float!
  surcharges: [CartItemSurcharge!]!
  product: Product
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the cart item, this id can be used for update or delete mutation for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on cart item level

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>sum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>sumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>totalSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>totalSumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this cart item

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>bundleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's bundleId if applicable

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's productId if applicable

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expected delivery date for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>deliveryDeadline</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>surcharges</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartItemSurcharge!]!</b></code>](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The surcharges applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>ICartBaseItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

### Implemented By

[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ICart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/icart

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface ICart {
  cartId: String!
  userId: Int!
  channelId: Int
  carrier: String!
  notes: String
  reference: String
  extra3: String
  extra4: String
  orderStatus: String
  actionCode: String
  couponCode: String
  vouchers: [CartVoucher!]
  paymentData: CartPaymentData
  postageData: CartPostageData
  total: CartTotal
  items: [CartMainItem!]
  bonusItems: [CartBaseItem!]
  invoiceAddress: CartAddress!
  deliveryAddress: CartAddress!
  taxLevels: [CartTaxLevel!]
  payMethods: [CartPaymethod!]
  carriers: [CartCarrier!]
  dateCreated: DateTime
  dateChanged: DateTime
  incentives: [CartIncentive!]
  valuePoints: Int
  user: IBaseUser!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The carts primary identifier

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The userId for this cart. The userId can only be set once.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The channel identifier this cart belongs to.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's remarks for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's reference for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>orderStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Status of the order after processing the cart. When order status is UNFINISHED, the cart is pending payment from PSP.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ActionCode that is applied to this cart. Is only filled when an valid action is applied

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>couponCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

CouponCode that is applied to this cart. Is only filled when an valid couponCode is applied

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>vouchers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartVoucher!]</b></code>](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Array of applied voucherCodes that are applied to this cart. Is only filled when an valid action is applied

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPaymentData</b></code>](/reference/legacy/graphql-v1/objects/cart-payment-data.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPostageData</b></code>](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary " text="object"/>

Postage data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartTotal</b></code>](/reference/legacy/graphql-v1/objects/cart-total.mdx) <Badge class="badge badge--secondary " text="object"/>

Totals for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartMainItem!]</b></code>](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The carts main items

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>bonusItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartBaseItem!]</b></code>](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

BonusItems that are added to this cart through incentives.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>invoiceAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddress!</b></code>](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The address the invoice for the order should be send to.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>deliveryAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddress!</b></code>](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The address the order should be send to.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>taxLevels</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartTaxLevel!]</b></code>](/reference/legacy/graphql-v1/objects/cart-tax-level.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Amount of tax that applies to this cart per tax code

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>payMethods</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartPaymethod!]</b></code>](/reference/legacy/graphql-v1/objects/cart-paymethod.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable paymethods for this cart and applied user.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>carriers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartCarrier!]</b></code>](/reference/legacy/graphql-v1/objects/cart-carrier.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable carriers for this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date this cart has been created.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>dateChanged</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date this cart has been last updated.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>incentives</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartIncentive!]</b></code>](/reference/legacy/graphql-v1/objects/cart-incentive.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

All incentives that apply to this cart.

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this cart

#### [<code style={{ fontWeight: 'normal' }}>ICart.<b>user</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

### Returned By

[`cart`](/reference/legacy/graphql-v1/queries/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Implemented By

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IClusterDrillDown

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/icluster-drill-down

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The interface for the ClusterDrillDown type, this describes the a cluster's drill down cosfiguration.

```graphql
interface IClusterDrillDown {
  attributeId: String!
  priority: Int!
  displayType: ClusterDrillDownDisplayTypes!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IClusterDrillDown.<b>attributeId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the Attribute to create the drilldown matrix for

#### [<code style={{ fontWeight: 'normal' }}>IClusterDrillDown.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The order in which the drilldown should be generated

#### [<code style={{ fontWeight: 'normal' }}>IClusterDrillDown.<b>displayType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ClusterDrillDownDisplayTypes!</b></code>](/reference/legacy/graphql-v1/enums/cluster-drill-down-display-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicator how to display the current drilldown selection

### Implemented By

[`ClusterDrillDown`](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IClusterOption

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/icluster-option

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Container for a set of options belonging to a configurable cluster

```graphql
interface IClusterOption {
  id: Int!
  clusterOptionId: Int!
  isRequired: Boolean!
  isHidden: YesNo!
  defaultProduct: Product
  products: [Product!]!
  name: [LocalizedString!]!
  description: [LocalizedString!]!
  shortDescription: [LocalizedString!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>clusterOptionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The classID of the cluster that represents this cluster

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>isRequired</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether an option is required or not

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates whether an option is hidden or not

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>defaultProduct</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

The default product that should be selected for this option

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Product!]!</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The products that can be added as this typed of option.

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized product name as it is available in
the supported language defaults to the product's default language.

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The long description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

#### [<code style={{ fontWeight: 'normal' }}>IClusterOption.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The short description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

### Implemented By

[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ICluster

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/icluster

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The interface for the Cluster type

```graphql
interface ICluster {
  id: Int!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]!
  slug(language: String): [LocalizedString!]!
  sku: String!
  categoryId: Int!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
  clusterId: Int!
  products: [Product!]
  options: [ClusterOption!]
  drillDown: [ClusterDrillDown!]
  defaultProduct: Product
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized product name as it is available in
the supported language defaults to the product's default language.

##### [<code style={{ fontWeight: 'normal' }}>ICluster.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The long description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>ICluster.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The short description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>ICluster.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Slugified version of the product name, that can be used in urls.
A slug is available per language.

##### [<code style={{ fontWeight: 'normal' }}>ICluster.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Stock keeping unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default language for this product or cluster,
this is the language to fall back too, when there is no translation avaialbe in a specific language.

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>sources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductSource!]!</b></code>](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The classID of this cluster

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Product!]</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Array of selectable main products for this cluster, when the array contains more than one. Only one can be added per cart/order item

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>options</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ClusterOption!]</b></code>](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The configuration options for this cluster

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>drillDown</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ClusterDrillDown!]</b></code>](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The drilldown configuration for this cluster

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>defaultProduct</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

The default product that should be selected for this option

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

#### [<code style={{ fontWeight: 'normal' }}>ICluster.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Path is no longer supported



The catalog path of this product.
Contains a list of ID's of categories with a / as delimiter

</Details>

### Implemented By

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IProductOffer

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iproduct-offer

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Interface for the ProductOffer Type

```graphql
interface IProductOffer {
  id: String!
  price: Float!
  validFrom: DateTime!
  validTo: DateTime!
  formula: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IProductOffer.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the offer.

#### [<code style={{ fontWeight: 'normal' }}>IProductOffer.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The calculated price for this offer.

#### [<code style={{ fontWeight: 'normal' }}>IProductOffer.<b>validFrom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProductOffer.<b>validTo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProductOffer.<b>formula</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Implemented By

[`ProductOffer`](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IProduct

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iproduct

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Interface for the Product Type

```graphql
interface IProduct {
  id: Int!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]!
  slug(language: String): [LocalizedString!]!
  sku: String!
  categoryId: Int!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
  productId: Int!
  shortName: String!
  manufacturerCode: String!
  eanCode: String!
  manufacturer: String!
  supplier: String!
  supplierCode: String!
  tag: String!
  taxCode: TaxCode!
  status: ProductStatus!
  isOrderable: YesNo!
  isReturnable: YesNo!
  hasBundle: YesNo!
  isBundleLeader: YesNo!
  package: String!
  packageUnit: String!
  packageUnitQuantity: String!
  priceDisplay: String!
  originalPrice: Float!
  costPrice: Float!
  suggestedPrice: Float!
  storePrice: Float!
  creditPoints: Float!
  minimumQuantity: Float!
  unit: Int!
  purchaseUnit: Int!
  purchaseMinimumQuantity: Int!
  econommicOrderQuantity: Int!
  orderableFrom: DateTime
  orderableTo: DateTime
  releaseDate: DateTime
  dateCreated: DateTime!
  dateChanged: DateTime!
  offers: [ProductOffer!]
  containerClass: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized product name as it is available in
the supported language defaults to the product's default language.

##### [<code style={{ fontWeight: 'normal' }}>IProduct.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The long description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>IProduct.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The short description for this product,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>IProduct.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Slugified version of the product name, that can be used in urls.
A slug is available per language.

##### [<code style={{ fontWeight: 'normal' }}>IProduct.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Stock keeping unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default language for this product or cluster,
this is the language to fall back too, when there is no translation avaialbe in a specific language.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>sources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductSource!]!</b></code>](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

This product's classID

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>shortName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The short name product.
Commonly used for connections with third parties that
have a size limitation on the product name field.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Original Equipment Manufacturer code for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The European Article Number or barcode for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer name for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The supplier of this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The supplierCode as it's know at the given supplier of this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tag of this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TaxCode!</b></code>](/reference/legacy/graphql-v1/enums/tax-code.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this product, either:
H = High
L = Low
N = No tax

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductStatus!</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The status of this product:

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>isOrderable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The orderable status of this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>isReturnable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The returnable status of this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is this product part of any product bundles.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is this product leader of any product bundle.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package type for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>packageUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>packageUnitQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package unit quantity for this product.

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>priceDisplay</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates how a product should be shown

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Original price of the product

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product cost price

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>suggestedPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product suggested price

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>storePrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product store price

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>creditPoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product credit points

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimum quantity

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product unit

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>purchaseUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product purchase unit

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>purchaseMinimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimum purchasable quantity

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>econommicOrderQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimal economic order quantity

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>orderableFrom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product orderable from date

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>orderableTo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product orderable to date

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>releaseDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product release date

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product creation date

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>dateChanged</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product last modified date

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>offers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductOffer!]</b></code>](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Available offers for this product and User. First item in the array should be regarded as the active price

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>containerClass</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the product's container, can be either folder or cluster

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

#### [<code style={{ fontWeight: 'normal' }}>IProduct.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Path is no longer supported



The catalog path of this product.
Contains a list of ID's of categories with a / as delimiter

</Details>

### Implemented By

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## IResource

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/iresource

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
interface IResource {
  id: Int!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>IResource.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>IResource.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>IResource.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>IResource.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>IResource.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

</Details>

### Implemented By

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ITenderBaseItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/interfaces/itender-base-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Interface for the TenderBaseItem Type, where both TenderBaseItem and TenderMainItem derive from

```graphql
interface ITenderBaseItem {
  id: Int!
  orderItemId: Int
  name: String!
  productId: Int!
  sku: String!
  quantity: Int!
  supplier: String!
  supplierCode: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  taxCode: Taxcode!
  taxPercentage: Int!
  customerDiscountPercentage: Float!
  discountPercentage: Float!
  totalDiscountPercentage: Float!
  marginAmount: Float!
  marginPercentage: Float!
  saleMarginAmount: Float!
  saleMarginPercentage: Float!
  attributedSaleDiscount: Float!
  attributedSaleMargin: Float!
  originalPrice: Float!
  costPrice: Float!
  customerPrice: Float!
  valuePoints: Int
  expectedDeliveryDate: DateTime
  externalOrderitemId: String
  notes: String!
  type: TenderOrderItemType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the tender item, this id can be used for update or delete mutation for this tender item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>orderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Id of the order item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item name

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tender/order item's productId, if applicable

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item SKU

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier code

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>customerDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer discount (%)

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Sales discount (%)

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>totalDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total discount (%)

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>marginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin amount (list price). VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>marginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin percentage (list price)

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>saleMarginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin amount. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>saleMarginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>attributedSaleDiscount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Extra item discount (%) calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>attributedSaleMargin</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product list price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product cost price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer special price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>externalOrderitemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order item's ID in an external system

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on tender item level

#### [<code style={{ fontWeight: 'normal' }}>ITenderBaseItem.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderOrderItemType!</b></code>](/reference/legacy/graphql-v1/enums/tender-order-item-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order item type

### Member Of

[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

### Implemented By

[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## addCompanyManager

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/add-company-manager

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
addCompanyManager(
  userId: Int!
  companyId: Int!
): String!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addCompanyManager.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The account manager added to the company

#### [<code style={{ fontWeight: 'normal' }}>addCompanyManager.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The company for which the account manager is added

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

---

## authenticationCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/authentication-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
authenticationCreate(
  input: CreateAuthenticationInput!
): Login!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>authenticationCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateAuthenticationInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-authentication-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Login</b></code>](/reference/legacy/graphql-v1/objects/login.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## authenticationDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/authentication-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
authenticationDelete(
  uid: String!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>authenticationDelete.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## bundleAddItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/bundle-add-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
bundleAddItems(
  id: Int!
  input: BundleAddItemsInput!
): [BundleItem!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleAddItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Bundle identifier

#### [<code style={{ fontWeight: 'normal' }}>bundleAddItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleAddItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/bundle-add-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BundleItem</b></code>](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## bundleCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/bundle-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
bundleCreate(
  input: CreateBundleInput!
): Bundle!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateBundleInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-bundle-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Bundle</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## bundleDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/bundle-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
bundleDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## bundleRemoveItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/bundle-remove-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
bundleRemoveItem(
  id: Int!
  productId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleRemoveItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>bundleRemoveItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## bundleUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/bundle-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
bundleUpdate(
  id: Int!
  input: UpdateBundleInput!
): Bundle!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundleUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Bundle identifier

#### [<code style={{ fontWeight: 'normal' }}>bundleUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateBundleInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-bundle-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Bundle</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## businessRuleCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new business rule with specified configuration and logic.

Establishes a new business rule with the provided name and type.
The created rule will have a basic structure that can be extended with decision tables, expressions, and workflow logic.

Possible errors:

- BUSINESS_RULE_UNKNOWN_ERROR: Unexpected error occurred during rule creation
- FORBIDDEN: Insufficient permissions to create business rules

AUTH: Role=[configuration.OWNER]

```graphql
businessRuleCreate(
  input: BusinessRuleCreateInput!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Business rule creation data including name, and type for the new rule

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## businessRuleDecisionTableAddColumn

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-column

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Add a new column to a decision table in a business rule.

Creates a new input or output column with the specified configuration and data type.
The column will be added to all existing rows with default empty values.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableAddColumn(
  input: BusinessRuleDecisionTableAddColumnInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableAddColumn.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableAddColumnInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-add-column-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableAddRow

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-row

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Add a new row to a decision table in a business rule.

Creates a new row with empty cell values for all existing input and output columns.
The row can then be populated with conditions and actions using the setCell mutation.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableAddRow(
  input: BusinessRuleDecisionTableSearchInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableAddRow.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableSearchInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-search-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableDeleteColumn

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-column

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Delete a column from a decision table in a business rule.

Removes the specified input or output column and all associated cell values from all rows.
This action is irreversible and may affect rule logic and execution.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_COLUMN_NOT_FOUND_ERROR: Column with the specified ID does not exist in the decision table
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableDeleteColumn(
  input: BusinessRuleDecisionTableDeleteColumnInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableDeleteColumn.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableDeleteColumnInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-column-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableDeleteRow

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-row

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Delete a row from a decision table in a business rule.

Permanently removes the specified row and all its associated cell values from the decision table.
This action is irreversible and may affect rule logic and execution.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_ROW_NOT_FOUND_ERROR: Row with the specified ID does not exist in the decision table
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableDeleteRow(
  input: BusinessRuleDecisionTableDeleteRowInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableDeleteRow.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableDeleteRowInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-row-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableMoveRow

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-move-row

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Move a row to a different position within a decision table.

Reorders rows in the decision table by moving the specified row before or after the target row.
Row order can affect rule evaluation depending on the hit policy configuration.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_ROW_NOT_FOUND_ERROR: Source or target row with the specified ID does not exist in the decision table
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableMoveRow(
  input: BusinessRuleDecisionTableMoveRowInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableMoveRow.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableMoveRowInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-move-row-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableSetCell

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-set-cell

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Set the value of a specific cell in a decision table row.

Updates the content of a cell at the intersection of a specific row and column with the provided value, expression, or localized content.
Supports different data types including strings, numbers, expressions, and localized values.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_ROW_NOT_FOUND_ERROR: Row with the specified ID does not exist in the decision table
- BUSINESS_RULE_DECISION_TABLE_CELL_NOT_FOUND_ERROR: Cell with the specified column ID does not exist in the specified row
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableSetCell(
  input: BusinessRuleDecisionTableSetCellInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableSetCell.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableSetCellInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDecisionTableUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-decision-table-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update the basic configuration and metadata of a decision table.

Modifies decision table properties such as hit policy, name, and other configuration settings.
Only the provided fields will be updated while others remain unchanged.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule
- BUSINESS_RULE_DECISION_TABLE_UPDATE_ERROR: Failed to update the decision table due to validation or system errors
- FORBIDDEN: Insufficient permissions to modify decision tables

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleDecisionTableUpdate(
  input: BusinessRuleDecisionTableUpdateInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTableUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a business rule and all its associated data from the system.

Removes the business rule including all decision tables, expressions, and configuration.
This action is irreversible and may affect dependent workflows and processes.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DELETE_ERROR: Failed to delete the business rule due to system constraints
- FORBIDDEN: Insufficient permissions to delete business rules

AUTH: Role=[configuration.OWNER]

```graphql
businessRuleDelete(
  id: ID!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the business rule to permanently delete from the system

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## businessRuleUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/business-rule-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing business rule's basic configuration and metadata.

Modifies business rule properties such as name and other basic settings.
Only the provided fields will be updated while others remain unchanged.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_UPDATE_ERROR: Failed to update the business rule due to validation or system errors
- FORBIDDEN: Insufficient permissions to update business rules

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
businessRuleUpdate(
  id: ID!
  input: BusinessRuleUpdateInput!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the business rule to update

#### [<code style={{ fontWeight: 'normal' }}>businessRuleUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated business rule data containing the fields to be modified

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## carrierAssignWarehouseAndReturnCarrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/carrier-assign-warehouse-and-return-carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Assign a warehouse to a carrier and return the updated carrier.

    Associates a warehouse with a carrier to enable shipping services from that fulfillment location. Returns the updated carrier with the new warehouse assignment for immediate use in shipping calculations. Validates warehouse existence against the warehouse service before assignment.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;ASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to assign warehouse to carrier due to data source issues or warehouse validation failure
    - FORBIDDEN: Insufficient permissions to assign warehouses to carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierAssignWarehouseAndReturnCarrier(
  id: Int!
  warehouseId: Int!
): Carrier!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouseAndReturnCarrier.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse assignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierAssignWarehouseAndReturnCarrier.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to assign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be validated against the warehouse service before assignment.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

---

## carrierCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/carrier-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new shipping carrier in the system.

    Establishes a new carrier with service details, coverage areas, pricing information, and integration settings. The carrier will be available for shipping calculations and logistics operations immediately after creation. Validates warehouse IDs against the warehouse service to ensure coverage areas exist.

    Possible errors:
    - CARRIER&#x005F;CREATE&#x005F;ERROR: Failed to create the carrier due to data source issues or warehouse validation failure
    - CARRIER&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Carrier with the same name already exists within the organization
    - FORBIDDEN: Insufficient permissions to create carriers

    AUTH: Role=[logistics.OWNER]

```graphql
carrierCreate(
  input: CarrierCreateInput!
): Carrier!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/carrier-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Carrier creation data including service details and configuration.

      Contains all required and optional carrier information including name (maximum 64 characters), service type, localized descriptions, shipping cost, tracking URL template (HTTPS only), logo URL, and warehouse coverage areas. All warehouse IDs are validated against the warehouse service.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

---

## carrierDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/carrier-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a carrier from the system.

    Removes the carrier and all associated configuration including warehouse assignments and service settings. This action cannot be undone and will affect any shipping operations that depend on this carrier. Ensure the carrier is not actively used before deletion.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;DELETE&#x005F;ERROR: Failed to delete the carrier due to data source issues or referential integrity constraints
    - FORBIDDEN: Insufficient permissions to delete carriers

    AUTH: Role=[logistics.OWNER]

```graphql
carrierDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier to delete.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the specific carrier for permanent removal.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## carrierUnassignWarehouseAndReturnCarrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/carrier-unassign-warehouse-and-return-carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Remove warehouse assignment from a carrier and return the updated carrier.

    Disassociates a warehouse from a carrier, removing shipping services from that fulfillment location. Returns the updated carrier with the warehouse removed from coverage areas for immediate use in shipping calculations.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;UNASSIGN&#x005F;WAREHOUSE&#x005F;ERROR: Failed to unassign warehouse from carrier due to data source issues
    - FORBIDDEN: Insufficient permissions to unassign warehouses from carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierUnassignWarehouseAndReturnCarrier(
  id: Int!
  warehouseId: Int!
): Carrier!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouseAndReturnCarrier.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the carrier for warehouse unassignment.

#### [<code style={{ fontWeight: 'normal' }}>carrierUnassignWarehouseAndReturnCarrier.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the warehouse to unassign.

      Must be a positive integer representing a valid warehouse ID in the system. This warehouse will be removed from the carrier's coverage areas.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

---

## carrierUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/carrier-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing carrier's configuration.

    Modifies carrier details including service type, localized descriptions, pricing information, tracking URL template, logo, and warehouse coverage areas. Only provided fields will be updated, others remain unchanged. Validates warehouse IDs against the warehouse service if provided.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;UPDATE&#x005F;ERROR: Failed to update the carrier due to data source issues or warehouse validation failure
    - CARRIER&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Updated name conflicts with existing carrier within the organization
    - FORBIDDEN: Insufficient permissions to update carriers

    AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
carrierUpdate(
  id: Int!
  input: CarrierUpdateInput!
): Carrier!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrierUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier to update.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the specific carrier for modification.

#### [<code style={{ fontWeight: 'normal' }}>carrierUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated carrier information.

      Contains the carrier properties to update including name (maximum 64 characters), service type, localized descriptions, shipping cost, tracking URL template (HTTPS only), logo URL, and warehouse coverage areas. Only provided fields will be changed, others remain unchanged. All warehouse IDs are validated against the warehouse service.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

---

## cartAddActionCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-add-action-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartAddActionCode(
  cartId: String!
  actionCode: String!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartAddActionCode.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cartAddActionCode.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartAddBundle

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-add-bundle

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartAddBundle(
  input: CartAddBundleInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartAddBundle.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddBundleInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-add-bundle-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartAddItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-add-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartAddItem(
  input: CartAddItemInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartAddItem.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddItemInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-add-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartAddVoucherCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-add-voucher-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartAddVoucherCode(
  cartId: String!
  voucherCode: String!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartAddVoucherCode.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cartAddVoucherCode.<b>voucherCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartDeleteItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-delete-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartDeleteItem(
  input: CartDeleteItemInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartDeleteItem.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartDeleteItemInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-delete-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartDelete(
  cartId: String!
): CartDeleteResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartDelete.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartDeleteResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-delete-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartProcess

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-process

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartProcess(
  input: CartProcessInput!
): CartProcessResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartProcess.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartProcessInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-process-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartProcessResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-process-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartRemoveActionCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-remove-action-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartRemoveActionCode(
  cartId: String!
  actionCode: String!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartRemoveActionCode.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cartRemoveActionCode.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartRemoveVoucherCode

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-remove-voucher-code

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartRemoveVoucherCode(
  cartId: String!
  voucherCode: String!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartRemoveVoucherCode.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cartRemoveVoucherCode.<b>voucherCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartSetUser

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-set-user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartSetUser(
  input: CartSetUserInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartSetUser.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartSetUserInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-set-user-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartStart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-start

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartStart(
  siteId: Int
  channelId: Int
  userId: Int
): Cart!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartStart.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! SiteId is no longer needed!

#### [<code style={{ fontWeight: 'normal' }}>cartStart.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Channel identifier [optional]

#### [<code style={{ fontWeight: 'normal' }}>cartStart.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User identifier [optional]

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Cart</b></code>](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartUpdateAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-update-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartUpdateAddress(
  input: CartUpdateAddressInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartUpdateAddress.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartUpdateAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-update-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartUpdateItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-update-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Do not use this mutation to update multiple cart items, `cartUpdateItems` mutation should be used in that case.

```graphql
cartUpdateItem(
  input: CartUpdateItemInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartUpdateItem.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartUpdateItemInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-update-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartUpdateItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-update-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Use this mutation when necessary to update multiple items in a single request, otherwise use `cartUpdateItem` mutation.

```graphql
cartUpdateItems(
  cartId: String!
  items: [CartUpdateItemsInput!]!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartUpdateItems.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cartUpdateItems.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartUpdateItemsInput!]!</b></code>](/reference/legacy/graphql-v1/inputs/cart-update-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cartUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/cart-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cartUpdate(
  input: CartUpdateInput!
): CartResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cartUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/cart-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CartResponse</b></code>](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## categoryCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/category-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER] OR ('user is authenticated')

```graphql
categoryCreate(
  input: CreateCategoryInput!
): Category!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>categoryCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateCategoryInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-category-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Category</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## categoryDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/category-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER] OR ('user is authenticated')

```graphql
categoryDelete(
  categoryId: Float!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>categoryDelete.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## categoryUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/category-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR] OR ('user is authenticated')

```graphql
categoryUpdate(
  categoryId: Float!
  input: UpdateCategoryInput!
): Category!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>categoryUpdate.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>categoryUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateCategoryInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-category-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Category</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## channelInvalidateCache

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/channel-invalidate-cache

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
channelInvalidateCache: Boolean!
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## claimsReset

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/claims-reset

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
claimsReset(
  uid: String!
  email: String!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>claimsReset.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>claimsReset.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## companyAddressCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-address-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

```graphql
companyAddressCreate(
  input: CompanyAddressCreateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyAddressCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanyAddressCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## companyAddressDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-address-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

```graphql
companyAddressDelete(
  input: CompanyAddressDeleteInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyAddressDelete.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanyAddressDeleteInput!</b></code>](/reference/legacy/graphql-v1/inputs/company-address-delete-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## companyAddressUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-address-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

```graphql
companyAddressUpdate(
  input: CompanyAddressUpdateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyAddressUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanyAddressUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/company-address-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## companyCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
companyCreate(
  input: CreateCompanyInput!
): Company!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateCompanyInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-company-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Company</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## companyDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
companyDelete(
  companyId: Int!
): String!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyDelete.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

---

## companyUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/company-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
companyUpdate(
  input: UpdateCompanyInput!
): Company!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companyUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateCompanyInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-company-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Company</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contactCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/contact-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new contact, if you want this new contact to be able to login, please use contactRegister

```graphql
contactCreate(
  input: CreateContactInput!
): Contact!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contactCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateContactInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Contact</b></code>](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contactDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/contact-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
contactDelete(
  contactId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contactDelete.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## contactRegister

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/contact-register

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new contact and a new login account for this contact

```graphql
contactRegister(
  input: RegisterContactInput!
): RegisterContactResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contactRegister.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterContactInput!</b></code>](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>RegisterContactResponse</b></code>](/reference/legacy/graphql-v1/objects/register-contact-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contactUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/contact-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
contactUpdate(
  input: UpdateContactInput!
): Contact!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contactUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateContactInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Contact</b></code>](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerAddressCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-address-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

```graphql
customerAddressCreate(
  input: CustomerAddressCreateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerAddressCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerAddressCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerAddressDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-address-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

```graphql
customerAddressDelete(
  input: CustomerAddressDeleteInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerAddressDelete.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerAddressDeleteInput!</b></code>](/reference/legacy/graphql-v1/inputs/customer-address-delete-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## customerAddressUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-address-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

```graphql
customerAddressUpdate(
  input: CustomerAddressUpdateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerAddressUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerAddressUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/customer-address-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new customer, if you want this new customer to be able to login, please use customerRegister

```graphql
customerCreate(
  input: CustomerInput!
): Customer!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerInput!</b></code>](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Customer</b></code>](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
customerDelete(
  customerId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerDelete.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## customerRegister

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-register

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new customer and a new login account for this customer

```graphql
customerRegister(
  input: RegisterCustomerInput!
): RegisterCustomerResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerRegister.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterCustomerInput!</b></code>](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>RegisterCustomerResponse</b></code>](/reference/legacy/graphql-v1/objects/register-customer-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/customer-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
customerUpdate(
  input: UpdateCustomerInput!
): Customer!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateCustomerInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Customer</b></code>](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## discountInvalidateCache

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/discount-invalidate-cache

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
discountInvalidateCache(
  userIds: [Int!]!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>discountInvalidateCache.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## exchangeRefreshToken

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/exchange-refresh-token

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
exchangeRefreshToken(
  input: ExchangeRefreshTokenInput!
): RefreshTokenResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>exchangeRefreshToken.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExchangeRefreshTokenInput!</b></code>](/reference/legacy/graphql-v1/inputs/exchange-refresh-token-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>RefreshTokenResponse</b></code>](/reference/legacy/graphql-v1/objects/refresh-token-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## externalAddressCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/external-address-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
externalAddressCreate(
  input: ExternalAddressCreateInput!
): ExternalAddress!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>externalAddressCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExternalAddressCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/external-address-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ExternalAddress</b></code>](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## externalAddressDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/external-address-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
externalAddressDelete(
  input: ExternalAddressDeleteInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>externalAddressDelete.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExternalAddressDeleteInput!</b></code>](/reference/legacy/graphql-v1/inputs/external-address-delete-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## externalAddressUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/external-address-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER,configuration.EDITOR] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
externalAddressUpdate(
  input: ExternalAddressUpdateInput!
): ExternalAddress!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>externalAddressUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ExternalAddressUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/external-address-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ExternalAddress</b></code>](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteListAddItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-add-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteListAddItems(
  id: String!
  input: FavoriteListsItemsInput!
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListAddItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

#### [<code style={{ fontWeight: 'normal' }}>favoriteListAddItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteListClearItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-clear-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteListClearItems(
  id: String!
  products: Boolean
  clusters: Boolean
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListClearItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

#### [<code style={{ fontWeight: 'normal' }}>favoriteListClearItems.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Clear Products?

#### [<code style={{ fontWeight: 'normal' }}>favoriteListClearItems.<b>clusters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Clear Clusters?

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteListCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[shop.OWNER] OR (('user is authenticated') AND ('undefined'))

```graphql
favoriteListCreate(
  input: FavoriteListsCreateInput!
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteListDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteListDelete(
  id: String!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## favoriteListRemoveItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-remove-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteListRemoveItems(
  id: String!
  input: FavoriteListsItemsInput!
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListRemoveItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

#### [<code style={{ fontWeight: 'normal' }}>favoriteListRemoveItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteListUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/favorite-list-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteListUpdate(
  id: String!
  input: FavoriteListsUpdateInput!
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteListUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

#### [<code style={{ fontWeight: 'normal' }}>favoriteListUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## incentiveRuleCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/incentive-rule-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a specialized business rule configured for incentive and discount management.

Initializes a business rule with a pre-configured decision table containing order items input/output columns
and the necessary structure for implementing incentive actions such as discounts, promotions, and special offers.

Possible errors:

- BUSINESS_RULE_UNKNOWN_ERROR: Unexpected error occurred during incentive rule creation
- FORBIDDEN: Insufficient permissions to create incentive rules

AUTH: Role=[configuration.OWNER]

```graphql
incentiveRuleCreate(
  input: BusinessRuleCreateInput!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>incentiveRuleCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Business rule creation data with incentive-specific configuration and metadata

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## incentiveRuleSetAction

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/incentive-rule-set-action

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Configure the incentive action and discount settings for an incentive rule.

Defines the specific incentive action to be applied when rule conditions are met, including discount types,
amounts, and application logic for promotional offers and special pricing.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Incentive rule with the specified ID does not exist
- BUSINESS_RULE_UPDATE_ERROR: Failed to update the incentive rule action
- FORBIDDEN: Insufficient permissions to modify incentive rules

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
incentiveRuleSetAction(
  input: IncentiveRuleSetActionInput!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>incentiveRuleSetAction.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IncentiveRuleSetActionInput!</b></code>](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Configuration data for setting incentive actions, discount types, and promotional settings

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## incentiveRuleSetOrderItemConditions

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/incentive-rule-set-order-item-conditions

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Configure order item conditions for an incentive rule using complex expressions.

Constructs and applies complex expressions to the incentive rule's decision table cells for order items processing.
Enables sophisticated filtering and condition logic for determining when incentives should be applied to specific order items.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Incentive rule with the specified ID does not exist
- BUSINESS_RULE_UPDATE_ERROR: Failed to update the incentive rule conditions
- FORBIDDEN: Insufficient permissions to modify incentive rules

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
incentiveRuleSetOrderItemConditions(
  input: IncentiveRuleOrderItemSetCellInput!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>incentiveRuleSetOrderItemConditions.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IncentiveRuleOrderItemSetCellInput!</b></code>](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Configuration data for setting order item conditions and filtering criteria

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## inventoryCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/inventory-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
inventoryCreate(
  input: CreateInventoryInput!
): InventoryResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>inventoryCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateInventoryInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-inventory-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>InventoryResponse</b></code>](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## inventoryCsvImport

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/inventory-csv-import

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
inventoryCsvImport(
  input: InventoryCsvInput!
): CsvImportResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>inventoryCsvImport.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>InventoryCsvInput!</b></code>](/reference/legacy/graphql-v1/inputs/inventory-csv-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CsvImportResponse</b></code>](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## inventoryDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/inventory-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
inventoryDelete(
  id: Int!
): InventoryDeleteResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>inventoryDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>InventoryDeleteResponse</b></code>](/reference/legacy/graphql-v1/objects/inventory-delete-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## inventoryUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/inventory-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
inventoryUpdate(
  id: Int!
  input: UpdateInventoryInput!
): InventoryResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>inventoryUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>inventoryUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateInventoryInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-inventory-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>InventoryResponse</b></code>](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## login

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/login

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Logs in the authenticated user and returns a GCIP user session which includes the accessToken and refreshToken.

```graphql
login(
  input: LoginInput!
): Login!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>login.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>LoginInput!</b></code>](/reference/legacy/graphql-v1/inputs/login-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Login</b></code>](/reference/legacy/graphql-v1/objects/login.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## machineCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/machine-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
machineCreate(
  input: CreateSparePartsMachineInput!
): SparePartsMachine!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>machineCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateSparePartsMachineInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SparePartsMachine</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## machineDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/machine-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
machineDelete(
  id: String!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>machineDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## machineUpsert

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/machine-upsert

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
machineUpsert(
  input: UpsertSparePartsMachineInput!
): SparePartsMachine!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>machineUpsert.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpsertSparePartsMachineInput!</b></code>](/reference/legacy/graphql-v1/inputs/upsert-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SparePartsMachine</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaAttachmentCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-attachment-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,product.OWNER] OR (('user is authenticated') AND ('customerId or companyId if present in input matches JWT'))

```graphql
mediaAttachmentCreate(
  input: MediaAttachmentInput!
): MediaAttachment!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaAttachmentCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaAttachmentInput!</b></code>](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaAttachment</b></code>](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary " text="object"/>

Private attachment file with restricted access and ownership controls

---

## mediaAttachmentDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-attachment-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,product.OWNER]

```graphql
mediaAttachmentDelete(
  id: String!
): DeleteMediaAttachmentResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaAttachmentDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>DeleteMediaAttachmentResponse</b></code>](/reference/legacy/graphql-v1/objects/delete-media-attachment-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Response confirming successful deletion of a private attachment file

---

## mediaAttachmentUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-attachment-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR,product.OWNER,product.EDITOR]

```graphql
mediaAttachmentUpdate(
  id: String!
  input: UpdateMediaAttachmentInput!
): MediaAttachment!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaAttachmentUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>mediaAttachmentUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateMediaAttachmentInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-media-attachment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaAttachment</b></code>](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary " text="object"/>

Private attachment file with restricted access and ownership controls

---

## mediaDocumentCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-document-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaDocumentCreate(
  input: MediaDocumentInput!
): MediaDocument!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocumentCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentInput!</b></code>](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaDocument</b></code>](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary " text="object"/>

Document media item with file access and metadata management capabilities

---

## mediaDocumentCsvImport

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-document-csv-import

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaDocumentCsvImport(
  input: DocumentCsvInput!
): CsvImportResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocumentCsvImport.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DocumentCsvInput!</b></code>](/reference/legacy/graphql-v1/inputs/document-csv-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CsvImportResponse</b></code>](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaDocumentDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-document-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaDocumentDelete(
  mediaId: String!
): DeleteMediaDocumentResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocumentDelete.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>DeleteMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/delete-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Response confirming successful deletion of a document media item

---

## mediaDocumentUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-document-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
mediaDocumentUpdate(
  input: UpdateMediaDocumentInput!
): MediaDocument!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaDocumentUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateMediaDocumentInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaDocument</b></code>](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary " text="object"/>

Document media item with file access and metadata management capabilities

---

## mediaImageCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-image-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaImageCreate(
  input: MediaImageInput!
): MediaImage!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImageCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageInput!</b></code>](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Image creation data including metadata, file uploads, and entity associations

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaImage</b></code>](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaImageCsvImport

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-image-csv-import

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaImageCsvImport(
  input: ImageCsvInput!
): CsvImportResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImageCsvImport.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ImageCsvInput!</b></code>](/reference/legacy/graphql-v1/inputs/image-csv-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

CSV file and field mapping configuration for bulk image import

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CsvImportResponse</b></code>](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaImageDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-image-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaImageDelete(
  mediaId: String!
): DeleteMediaImageResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImageDelete.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the image to delete permanently

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>DeleteMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/delete-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Response confirming successful deletion of an image media item

---

## mediaImageUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-image-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
mediaImageUpdate(
  input: UpdateMediaImageInput!
): MediaImage!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaImageUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateMediaImageInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Image update data including modified metadata and entity associations

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaImage</b></code>](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaVideoCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-video-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaVideoCreate(
  input: MediaVideoInput!
): MediaVideo!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideoCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoInput!</b></code>](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaVideo</b></code>](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaVideoCsvImport

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-video-csv-import

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaVideoCsvImport(
  input: VideoCsvInput!
): CsvImportResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideoCsvImport.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>VideoCsvInput!</b></code>](/reference/legacy/graphql-v1/inputs/video-csv-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CsvImportResponse</b></code>](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## mediaVideoDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-video-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER]

```graphql
mediaVideoDelete(
  mediaId: String!
): DeleteMediaVideoResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideoDelete.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>DeleteMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/delete-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Response confirming successful deletion of a video media item

---

## mediaVideoUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/media-video-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[product.OWNER,product.EDITOR]

```graphql
mediaVideoUpdate(
  input: UpdateMediaVideoInput!
): MediaVideo!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>mediaVideoUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateMediaVideoInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>MediaVideo</b></code>](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

```graphql
orderCreate(
  order: OrderCreateInput!
): Order!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderCreate.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Order</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER]

```graphql
orderDelete(
  orderId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderDelete.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## orderItemCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-item-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderItemCreate(
  orderId: Int!
  orderItem: OrderItemCreateInput!
): OrderItem!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderItemCreate.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderItemCreate.<b>orderItem</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>OrderItem</b></code>](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderItemDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-item-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderItemDelete(
  orderId: Int!
  orderItemId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderItemDelete.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderItemDelete.<b>orderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## orderItemUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-item-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderItemUpdate(
  orderId: Int!
  orderItem: OrderItemUpdateInput!
): OrderItem!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderItemUpdate.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderItemUpdate.<b>orderItem</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>OrderItem</b></code>](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderSendConfirmationEmail

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-send-confirmation-email

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderSendConfirmationEmail(
  orderId: Int!
  attachments: [Base64FileInput!]
): SendOrderConfirmResponseType!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderSendConfirmationEmail.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderSendConfirmationEmail.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Base64FileInput!]</b></code>](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SendOrderConfirmResponseType</b></code>](/reference/legacy/graphql-v1/objects/send-order-confirm-response-type.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderSetStatus

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-set-status

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderSetStatus(
  input: OrderSetStatusInput!
): Order!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderSetStatus.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderSetStatusInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-set-status-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Order</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderUpdateAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-update-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderUpdateAddress(
  id: Int!
  addressId: Int!
  input: OrderUpdateAddressInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the order

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>addressId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderUpdateAddress.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderUpdateAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-update-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## orderUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/order-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
orderUpdate(
  orderId: Int!
  order: OrderUpdateInput!
): Order!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderUpdate.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderUpdate.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Order</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistAddItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-add-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistAddItems(
  id: Int!
  input: OrderlistItemsInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistAddItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistAddItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistAssignCompanies

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-assign-companies

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistAssignCompanies(
  id: Int!
  input: OrderlistCompaniesInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistAssignCompanies.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistAssignCompanies.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistCompaniesInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-companies-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistAssignUsers

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-assign-users

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistAssignUsers(
  id: Int!
  input: OrderlistUsersInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistAssignUsers.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistAssignUsers.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistUsersInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-users-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistCreate(
  input: OrderlistCreateInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## orderlistRemoveItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-remove-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistRemoveItems(
  id: Int!
  input: OrderlistItemsInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistRemoveItems.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistRemoveItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistUnassignCompanies

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-unassign-companies

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistUnassignCompanies(
  id: Int!
  input: OrderlistCompaniesInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistUnassignCompanies.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistUnassignCompanies.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistCompaniesInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-companies-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistUnassignUsers

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-unassign-users

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistUnassignUsers(
  id: Int!
  input: OrderlistUsersInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistUnassignUsers.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistUnassignUsers.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistUsersInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-users-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlistUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/orderlist-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlistUpdate(
  id: Int!
  input: OrderlistUpdateInput!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlistUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>orderlistUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## passwordResetLink

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/password-reset-link

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Generates a password recovery link, that can be included in a password recovery e-mail.

```graphql
passwordResetLink(
  email: String
  redirectUrl: String
  input: PasswordRecoveryLinkInput
): String!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>passwordResetLink.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated, use input instead

#### [<code style={{ fontWeight: 'normal' }}>passwordResetLink.<b>redirectUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated, use input instead

#### [<code style={{ fontWeight: 'normal' }}>passwordResetLink.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PasswordRecoveryLinkInput</b></code>](/reference/legacy/graphql-v1/inputs/password-recovery-link-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

---

## payMethodCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/pay-method-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new payment method in the system.

    Establishes a new payment method with localized names, external integration codes, and branding elements. The payment method becomes immediately available for checkout processes and payment workflows.

    Validation requirements:
    - Names array must contain at least one localized string with unique languages
    - External code must follow SCREAMING&#x005F;SNAKE&#x005F;CASE format and be unique
    - Logo URL must be valid if provided (maximum 255 characters)

    Possible errors:
    - PAY&#x005F;METHOD&#x005F;EXTERNAL&#x005F;CODE&#x005F;ALREADY&#x005F;EXISTS: External code already exists for another payment method
    - PAY&#x005F;METHOD&#x005F;UNKNOWN&#x005F;ERROR: Unknown error occurred during payment method creation
    - UNAUTHENTICATED: Invalid or missing authentication
    - FORBIDDEN: Insufficient permissions to create payment methods

    AUTH: Role=[configuration.OWNER]

```graphql
payMethodCreate(
  input: PayMethodCreateInput!
): PayMethod!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payMethodCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PayMethodCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/pay-method-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Payment method creation data including configuration and processing settings.

      Contains payment method details, integration configuration, and all information needed to create a functional payment method.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PayMethod</b></code>](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment method configuration for checkout and payment processing.

Represents a payment option available to customers during checkout including configuration details, branding, and integration settings. Used for payment processing, checkout flows, and financial transaction management.

---

## payMethodDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/pay-method-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a payment method from the system.

    Removes the payment method and all associated configuration including localized names, external integration codes, and branding elements. This action cannot be undone and will affect any checkout processes that depend on this payment method.

    Possible errors:
    - PAY&#x005F;METHOD&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Payment method with the specified ID does not exist
    - PAY&#x005F;METHOD&#x005F;UNKNOWN&#x005F;ERROR: Unknown error occurred during payment method deletion
    - UNAUTHENTICATED: Invalid or missing authentication
    - FORBIDDEN: Insufficient permissions to delete payment methods

    AUTH: Role=[configuration.OWNER]

```graphql
payMethodDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payMethodDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the payment method to delete.

      Must be a positive integer representing a valid payment method ID in the system.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## payMethodUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/pay-method-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing payment method's configuration.

    Modifies payment method details including localized names, external integration codes, and branding elements. Only provided fields will be updated, others remain unchanged. Supports partial updates for flexible payment method management.

    Validation requirements:
    - Names array must contain unique languages if provided
    - External code must follow SCREAMING&#x005F;SNAKE&#x005F;CASE format and be unique if provided
    - Logo URL must be valid if provided (maximum 255 characters)

    Possible errors:
    - PAY&#x005F;METHOD&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Payment method with the specified ID does not exist
    - PAY&#x005F;METHOD&#x005F;EXTERNAL&#x005F;CODE&#x005F;ALREADY&#x005F;EXISTS: Updated external code already exists for another payment method
    - PAY&#x005F;METHOD&#x005F;UNKNOWN&#x005F;ERROR: Unknown error occurred during payment method update
    - UNAUTHENTICATED: Invalid or missing authentication
    - FORBIDDEN: Insufficient permissions to update payment methods

    AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
payMethodUpdate(
  id: Int!
  input: PayMethodUpdateInput!
): PayMethod!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payMethodUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the payment method to update.

      Must be a positive integer representing a valid payment method ID in the system.

#### [<code style={{ fontWeight: 'normal' }}>payMethodUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PayMethodUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/pay-method-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated payment method information.

      Contains the payment method properties to update. Only provided fields will be changed, others remain unchanged.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PayMethod</b></code>](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment method configuration for checkout and payment processing.

Represents a payment option available to customers during checkout including configuration details, branding, and integration settings. Used for payment processing, checkout flows, and financial transaction management.

---

## paymentCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/payment-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new payment record in the system.

Establishes a new payment entry with transaction details, payment method information, and processing status. The payment will be available for order processing and financial tracking immediately. Optionally creates an associated transaction record for atomic payment and transaction creation.

Possible errors:

- CREATE_PAYMENT_ERROR: Failed to create the payment due to system error
- PAYMENT_ALREADY_EXISTS_ERROR: Payment with the same identifier already exists
- CREATE_TRANSACTION_ERROR: Failed to create associated transaction when provided
- TRANSACTION_ALREADY_EXISTS_ERROR: Associated transaction with same identifier already exists
- FORBIDDEN: Insufficient permissions to create payments

AUTH: Role=[order.OWNER]

```graphql
paymentCreate(
  input: CreatePaymentInput!
): Payment!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>paymentCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreatePaymentInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-payment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Payment creation data including transaction details and payment method information.

      Contains all necessary information to create a payment record including amounts, payment method, and optional transaction data.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Payment</b></code>](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.

---

## paymentDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/payment-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a payment from the system.

Removes the payment record and all associated transaction data. This action cannot be undone and will affect any orders or financial reports that depend on this payment. Use with caution as this permanently removes financial records from the system.

Possible errors:

- DELETE_PAYMENT_ERROR: Failed to delete the payment due to system error
- PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
- FORBIDDEN: Insufficient permissions to delete payments

AUTH: Role=[order.OWNER]

```graphql
paymentDelete(
  searchBy: SearchByInput!
): Payment!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>paymentDelete.<b>searchBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SearchByInput!</b></code>](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Search criteria for finding the payment to delete.

      Specifies how to identify the payment (by ID, payment ID, or order ID) for removal.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Payment</b></code>](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.

---

## paymentUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/payment-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing payment's information.

Modifies payment details including status, amounts, transaction information, and processing details. Only provided fields will be updated, others remain unchanged. Supports partial updates for flexible payment management throughout the payment lifecycle.

Possible errors:

- UPDATE_PAYMENT_ERROR: Failed to update the payment due to system error
- PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
- PAYMENT_ALREADY_EXISTS_ERROR: Updated payment data conflicts with existing payment
- FORBIDDEN: Insufficient permissions to update payments

AUTH: Role=[order.OWNER,order.EDITOR]

```graphql
paymentUpdate(
  searchBy: SearchByInput!
  input: UpdatePaymentInput!
): Payment!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>paymentUpdate.<b>searchBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SearchByInput!</b></code>](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Search criteria for finding the payment to update.

      Specifies how to identify the payment (by ID, payment ID, or order ID) for modification.

#### [<code style={{ fontWeight: 'normal' }}>paymentUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdatePaymentInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-payment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated payment information.

      Contains the payment properties to update. Only provided fields will be changed, others remain unchanged.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Payment</b></code>](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.

---

## permissionsInvalidateCache

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/permissions-invalidate-cache

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
permissionsInvalidateCache(
  userIds: [Int!]!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>permissionsInvalidateCache.<b>userIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## productCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/product-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new product

```graphql
productCreate(
  input: CreateProductInput!
): Product!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>productCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateProductInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## productDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/product-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
productDelete(
  productId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>productDelete.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## productUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/product-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Updates a product

```graphql
productUpdate(
  input: UpdateProductInput!
): Product!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>productUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateProductInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## publishEmailEvent

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/publish-email-event

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Publishes an email trigger event to pub/sub, containing the abstract event data. AUTH: Role=[system]

```graphql
publishEmailEvent(
  input: EmailEventInput!
): PublishEmailEventResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>publishEmailEvent.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailEventInput!</b></code>](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PublishEmailEventResponse</b></code>](/reference/legacy/graphql-v1/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## publishEmailSendEvent

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/publish-email-send-event

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Publishes an email send trigger event to pub/sub containing all (processed) fields needed to send a single email. AUTH: Role=[system]

```graphql
publishEmailSendEvent(
  input: EmailSendEventInput!
): PublishEmailEventResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>publishEmailSendEvent.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>EmailSendEventInput!</b></code>](/reference/legacy/graphql-v1/inputs/email-send-event-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PublishEmailEventResponse</b></code>](/reference/legacy/graphql-v1/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## publishPasswordResetEmailEvent

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/publish-password-reset-email-event

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Publishes an email trigger event to pub/sub, containing the abstract event data and the password reset link

```graphql
publishPasswordResetEmailEvent(
  input: PasswordResetLinkEmailInput!
): PublishEmailEventResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>publishPasswordResetEmailEvent.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PasswordResetLinkEmailInput!</b></code>](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PublishEmailEventResponse</b></code>](/reference/legacy/graphql-v1/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## removeCompanyManager

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/remove-company-manager

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
removeCompanyManager(
  userId: Int!
  companyId: Int!
): String!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>removeCompanyManager.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The account manager to be removed

#### [<code style={{ fontWeight: 'normal' }}>removeCompanyManager.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The company for which the account manager is to be removed

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

---

## shopInvalidateCache

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/shop-invalidate-cache

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
shopInvalidateCache: Boolean!
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## startSession

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/start-session

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Starts an anonymous firebase session

```graphql
startSession(
  siteId: Int
): Login!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>startSession.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! siteId is no longer needed!

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Login</b></code>](/reference/legacy/graphql-v1/objects/login.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## taxCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tax-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
taxCreate(
  input: CreateTaxInput!
): Tax!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>taxCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateTaxInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-tax-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tax</b></code>](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## taxDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tax-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
taxDelete(
  id: ID!
): Tax!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>taxDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tax</b></code>](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## taxUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tax-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
taxUpdate(
  id: ID!
  input: UpdateTaxInput!
): Tax!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>taxUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>taxUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateTaxInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-tax-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tax</b></code>](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderAddItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-add-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderAddItems(
  input: TenderAddItemsInput!
): TenderResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderAddItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderAddItemsInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-add-items-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>TenderResponse</b></code>](/reference/legacy/graphql-v1/objects/tender-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderApplyIncentives

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-apply-incentives

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderApplyIncentives(
  tenderId: String!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderApplyIncentives.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderDeleteItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-delete-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderDeleteItem(
  input: TenderDeleteItemInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderDeleteItem.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderDeleteItemInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-delete-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderDelete(
  tenderId: String!
): String!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderDelete.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

---

## tenderProcess

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-process

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderProcess(
  tenderId: String!
): TenderProcessResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderProcess.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>TenderProcessResponse</b></code>](/reference/legacy/graphql-v1/objects/tender-process-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderStart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-start

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderStart(
  input: TenderStart!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderStart.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderStart!</b></code>](/reference/legacy/graphql-v1/inputs/tender-start.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdateAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdateAddress(
  input: TenderUpdateAddressInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdateAddress.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderUpdateAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-update-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdateDiscount

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-discount

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdateDiscount(
  input: TenderDiscountInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdateDiscount.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderDiscountInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-discount-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdateInvoiceUser

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-invoice-user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdateInvoiceUser(
  tenderid: String!
  userId: Int!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdateInvoiceUser.<b>tenderid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdateInvoiceUser.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdateItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdateItem(
  input: TenderUpdateItemInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdateItem.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderUpdateItemInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdatePayment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-payment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdatePayment(
  input: TenderPaymentInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdatePayment.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderPaymentInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-payment-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdatePostage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update-postage

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdatePostage(
  input: TenderPostageInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdatePostage.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderPostageInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tenderUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/tender-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tenderUpdate(
  input: TenderUpdateInput!
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tenderUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/tender-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userAddressCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-address-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
userAddressCreate(
  input: UserAddressCreateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAddressCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UserAddressCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userAddressDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-address-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER,configuration.EDITOR] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
userAddressDelete(
  input: UserAddressDeleteInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAddressDelete.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UserAddressDeleteInput!</b></code>](/reference/legacy/graphql-v1/inputs/user-address-delete-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## userAddressUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-address-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
userAddressUpdate(
  input: UserAddressUpdateInput!
): Address!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAddressUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UserAddressUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/user-address-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new user, if you want this new user to be able to login, please use userRegister

```graphql
userCreate(
  input: CreateUserInput!
): IBaseUser!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateUserInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-user-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

---

## userDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
userDelete(
  userId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userDelete.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## userRegister

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-register

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Creates a new user and a new login account for this user

```graphql
userRegister(
  input: RegisterUserInput!
): RegisterUserResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userRegister.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterUserInput!</b></code>](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>RegisterUserResponse</b></code>](/reference/legacy/graphql-v1/objects/register-user-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/user-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
userUpdate(
  input: UpdateUserInput!
): IBaseUser!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateUserInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-user-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

---

## usergroupCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/usergroup-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
usergroupCreate(
  input: CreateUsergroupInput!
): Usergroup!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>usergroupCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateUsergroupInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-usergroup-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## usergroupDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/usergroup-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
usergroupDelete(
  usergroupId: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>usergroupDelete.<b>usergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## usergroupUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/usergroup-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
usergroupUpdate(
  input: UpdateUsergroupInput!
): Usergroup!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>usergroupUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateUsergroupInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-usergroup-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesetCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new value set in the configuration system.

    Establishes a new value set with localized descriptions for use throughout the system. The value set will be available for dropdown lists, validation, and configuration immediately after creation.

    Requirements:
    • Name must be unique across all value sets (maximum 64 characters)
    • Only CUSTOM type value sets can be created via API
    • At least one description is required for proper internationalization
    • Descriptions support multiple languages with 2-character language codes

    Use this mutation to:
    • Create custom dropdown lists for business-specific needs
    • Establish validation sets for data entry forms
    • Set up configuration options for system features

    Possible errors:
    - VALUESET&#x005F;CREATE&#x005F;ERROR: Failed to create the value set due to system error
    - VALUESET&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Value set with the specified name already exists
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to create restricted value set type

    AUTH: Role=[configuration.OWNER]

```graphql
valuesetCreate(
  input: ValuesetCreateInput!
): Valueset!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/valueset-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Value set creation data including name, type, and localized descriptions.

      Contains all necessary information to create a functional value set. Name must be unique and descriptions should include at least one language for proper system integration.

      Validation constraints:
      • Name: 1-64 characters, unique across system
      • Type: Must be CUSTOM for user-created value sets
      • Descriptions: At least one entry with valid language code

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Valueset</b></code>](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesetDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a value set and all its items from the system.

    Removes the value set and all associated items in a cascading delete operation. This action cannot be undone and will affect any system components that depend on this value set.

    Restrictions:
    • SYSTEM type value sets cannot be deleted
    • All associated items will be permanently removed
    • Operation cannot be reversed once completed
    • May affect dependent configurations and dropdown lists

    Use this mutation with caution when:
    • Removing obsolete value sets that are no longer needed
    • Cleaning up test or development configurations
    • Consolidating duplicate value sets

    Possible errors:
    - VALUESET&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Value set with the specified ID does not exist
    - VALUESET&#x005F;DELETE&#x005F;ERROR: Failed to delete the value set due to system error
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to delete SYSTEM type value set

    AUTH: Role=[configuration.OWNER]

```graphql
valuesetDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the value set to delete.

      Must be a positive integer representing a valid, existing value set ID in the system. The value set must be of CUSTOM type to allow deletion.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## valuesetItemCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-item-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Create a new item within an existing value set.

    Adds a new selectable option to a value set with localized descriptions and optional metadata. The item will be immediately available for use in dropdown lists and validation throughout the system.

    Requirements:
    • Parent value set must exist and be accessible
    • Value must be unique within the parent value set (maximum 512 characters)
    • At least one description is required for proper internationalization
    • Only CUSTOM type value sets can have items added via API

    Use this mutation to:
    • Add new options to existing dropdown lists
    • Expand configuration choices for business needs
    • Create localized selection options for international users
    • Populate value sets with additional metadata

    Possible errors:
    - VALUESET&#x005F;ITEM&#x005F;CREATE&#x005F;ERROR: Failed to create the value set item due to system error
    - VALUESET&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Parent value set with specified ID does not exist
    - VALUESET&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Item with the specified value already exists in the value set
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to add item to SYSTEM type value set

    AUTH: Role=[configuration.OWNER]

```graphql
valuesetItemCreate(
  input: ValuesetItemCreateInput!
): ValuesetItem!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetItemCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemCreateInput!</b></code>](/reference/legacy/graphql-v1/inputs/valueset-item-create-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Value set item creation data including parent value set, value, descriptions, and optional metadata.

      Contains all necessary information to create a functional value set item. Value must be unique within the parent value set and descriptions should include at least one language.

      Validation constraints:
      • valuesetId: Must reference an existing CUSTOM type value set
      • value: 1-512 characters, unique within parent value set
      • descriptions: At least one entry with valid language code
      • extra: Optional metadata up to 512 characters

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ValuesetItem</b></code>](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesetItemDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-item-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Permanently delete a value set item from its parent value set.

    Removes the item from the value set and any configurations that reference it. This action cannot be undone and may affect dropdown lists or validation rules that depend on this item.

    Restrictions:
    • Items in SYSTEM type value sets cannot be deleted
    • Operation cannot be reversed once completed
    • May affect dependent configurations and dropdown lists

    Use this mutation with caution when:
    • Removing obsolete options that are no longer needed
    • Cleaning up test or development configurations
    • Consolidating duplicate items within value sets

    Possible errors:
    - VALUESET&#x005F;ITEM&#x005F;DELETE&#x005F;ERROR: Failed to delete the value set item due to system error
    - VALUESET&#x005F;ITEM&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Value set item with the specified ID does not exist
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to delete item from SYSTEM type value set

    AUTH: Role=[configuration.OWNER]

```graphql
valuesetItemDelete(
  id: Int!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetItemDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the value set item to delete.

      Must be a positive integer representing a valid, existing value set item ID. The item must belong to a CUSTOM type value set to allow deletion.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## valuesetItemUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-item-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing value set item's data and metadata.

    Modifies item details including value, localized descriptions, and extra metadata. Only provided fields will be updated, others remain unchanged. The parent value set association cannot be changed after creation.

    Restrictions:
    • Items in SYSTEM type value sets cannot be modified
    • Value changes must maintain uniqueness within the parent value set
    • Parent value set association is immutable
    • Value must not exceed 512 characters if provided

    Use this mutation to:
    • Update item values for better clarity or accuracy
    • Add or modify localized descriptions for internationalization
    • Update additional metadata stored in the extra field
    • Maintain item data without affecting parent value set

    Possible errors:
    - VALUESET&#x005F;ITEM&#x005F;UPDATE&#x005F;ERROR: Failed to update the value set item due to system error
    - VALUESET&#x005F;ITEM&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Value set item with the specified ID does not exist
    - VALUESET&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Updated value conflicts with another item in the same value set
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to modify item in SYSTEM type value set

    AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
valuesetItemUpdate(
  id: Int!
  input: ValuesetItemUpdateInput!
): ValuesetItem!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetItemUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the value set item to update.

      Must be a positive integer representing a valid, existing value set item ID. The item must belong to a CUSTOM type value set to allow modifications.

#### [<code style={{ fontWeight: 'normal' }}>valuesetItemUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/valueset-item-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated value set item information with partial field updates.

      Contains the item properties to update. All fields are optional - only provided fields will be changed, others remain unchanged.

      Validation constraints:
      • value: 1-512 characters if provided, must be unique within parent value set
      • descriptions: Valid language codes with meaningful descriptions
      • extra: Optional metadata up to 512 characters

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ValuesetItem</b></code>](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesetUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/valueset-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Update an existing value set's configuration and metadata.

    Modifies value set details including name and localized descriptions. Only provided fields will be updated, others remain unchanged. The type field cannot be modified after creation for data integrity reasons.

    Restrictions:
    • SYSTEM type value sets cannot be modified
    • Name changes must maintain uniqueness across all value sets
    • Type field is immutable after creation
    • Name must not exceed 64 characters if provided

    Use this mutation to:
    • Update value set names for better organization
    • Add or modify localized descriptions
    • Maintain value set metadata without affecting items

    Possible errors:
    - VALUESET&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Value set with the specified ID does not exist
    - VALUESET&#x005F;UPDATE&#x005F;ERROR: Failed to update the value set due to system error
    - VALUESET&#x005F;ALREADY&#x005F;EXISTS&#x005F;ERROR: Updated name conflicts with existing value set
    - VALUESET&#x005F;NOT&#x005F;ALLOWED&#x005F;TO&#x005F;MODIFY&#x005F;ERROR: Attempt to modify SYSTEM type value set

    AUTH: Role=[configuration.OWNER,configuration.EDITOR]

```graphql
valuesetUpdate(
  id: Int!
  input: ValuesetUpdateInput!
): Valueset!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the value set to update.

      Must be a positive integer representing a valid, existing value set ID in the system. The value set must be of CUSTOM type to allow modifications.

#### [<code style={{ fontWeight: 'normal' }}>valuesetUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetUpdateInput!</b></code>](/reference/legacy/graphql-v1/inputs/valueset-update-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Updated value set information with partial field updates.

      Contains the value set properties to update. All fields are optional - only provided fields will be changed, others remain unchanged.

      Validation constraints:
      • Name: 1-64 characters if provided, must be unique
      • Descriptions: Valid language codes with meaningful descriptions

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Valueset</b></code>](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## verifyToken

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/verify-token

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
verifyToken(
  input: VerifyTokenInput!
): VerifyToken!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>verifyToken.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>VerifyTokenInput!</b></code>](/reference/legacy/graphql-v1/inputs/verify-token-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>VerifyToken</b></code>](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouseAddressCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-address-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
warehouseAddressCreate(
  id: Float!
  input: CreateWarehouseAddressInput!
): WarehouseAddress!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressCreate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateWarehouseAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>WarehouseAddress</b></code>](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouseAddressDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-address-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
warehouseAddressDelete(
  id: Float!
  input: DeleteWarehouseAddressInput!
): Boolean!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressDelete.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DeleteWarehouseAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/delete-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Boolean` scalar type represents `true` or `false`.

---

## warehouseAddressUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-address-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
warehouseAddressUpdate(
  id: Float!
  input: UpdateWarehouseAddressInput!
): WarehouseAddress!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>warehouseAddressUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateWarehouseAddressInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>WarehouseAddress</b></code>](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouseCreate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-create

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
warehouseCreate(
  input: CreateWarehouseInput!
): Warehouse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseCreate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CreateWarehouseInput!</b></code>](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouseDelete

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-delete

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER]

```graphql
warehouseDelete(
  id: Float!
): Warehouse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseDelete.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouseUpdate

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/mutations/warehouse-update

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER,logistics.EDITOR]

```graphql
warehouseUpdate(
  id: Float!
  input: UpdateWarehouseInput!
): Warehouse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouseUpdate.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>warehouseUpdate.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UpdateWarehouseInput!</b></code>](/reference/legacy/graphql-v1/inputs/update-warehouse-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## Ace

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/ace

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Ace {
  aceId: Int!
  alow: Int!
  deny: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Ace.<b>aceId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Ace.<b>alow</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Ace.<b>deny</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

---

## Address

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Address {
  id: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  fax: String
  code: String
  notes: String
  isDefault: YesNo!
  type: AddressType!
  icp: YesNo
  url: String
  active: YesNo
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Address gender

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address street

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number extension

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fixed phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Mobile phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email that applies to this address [valid email format needed]

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>fax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fax number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is default for its type

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType!</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Address type [one of 'home', 'delivery', 'invoice']

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address company domain url

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>active</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the address is active

#### [<code style={{ fontWeight: 'normal' }}>Address.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address friendly descriptive name

### Returned By

[`addressesByCompanyId`](/reference/legacy/graphql-v1/queries/addresses-by-company-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByCustomerId`](/reference/legacy/graphql-v1/queries/addresses-by-customer-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByOrderId`](/reference/legacy/graphql-v1/queries/addresses-by-order-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByUserId`](/reference/legacy/graphql-v1/queries/addresses-by-user-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`companyAddressCreate`](/reference/legacy/graphql-v1/mutations/company-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`companyAddressUpdate`](/reference/legacy/graphql-v1/mutations/company-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`customerAddressCreate`](/reference/legacy/graphql-v1/mutations/customer-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`customerAddressUpdate`](/reference/legacy/graphql-v1/mutations/customer-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userAddressCreate`](/reference/legacy/graphql-v1/mutations/user-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userAddressUpdate`](/reference/legacy/graphql-v1/mutations/user-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## AttributeDecimalRangeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-decimal-range-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeDecimalRangeFilter implements IAttributeDecimalRangeFilter {
  min: Float!
  max: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeDecimalRangeFilter.<b>min</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Minumum value for this attribute

#### [<code style={{ fontWeight: 'normal' }}>AttributeDecimalRangeFilter.<b>max</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IAttributeDecimalRangeFilter</b></code>](/reference/legacy/graphql-v1/interfaces/iattribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## AttributeDescriptionResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-description-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeDescriptionResponse {
  items: [AttributeDescription!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeDescription!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type AttributeDescription

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescriptionResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`attributeDescription`](/reference/legacy/graphql-v1/queries/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## AttributeDescription

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-description

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeDescription {
  id: Int!
  name: String!
  searchId: String!
  description(language: String): [LocalizedString!]!
  type: AttributeType!
  typeParam: String!
  group: String!
  isSearchable: Boolean!
  isPublic: Boolean!
  isHidden: Boolean
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Attribute as it's defined in the Datebase

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Attribute as it's defined in the Datebase

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Lowercased representation of the id with an attr\_ prefix that can be
used in query parameters.
The attr\_ prefix is to avoid potential naming conflict with regular
product fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The human readable description of the attribute's name.
This is a language specific value.

##### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the attribute.
Possible values: - text - list - enum - enumlist - color - date - datetime - object - integer - decimal

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>typeParam</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the connected valueset to use when type is enum or enumlist

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>group</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The group this attribute belongs to.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
catalog page filters.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
product specs.

#### [<code style={{ fontWeight: 'normal' }}>AttributeDescription.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute us hidden and should
only be used for background operations.

### Member Of

[`AttributeDescriptionResponse`](/reference/legacy/graphql-v1/objects/attribute-description-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterDrillDown`](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## AttributeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeFilter implements IAttributeFilter {
  id: String!
  searchId: String!
  description: String!
  type: AttributeType!
  isSearchable: Boolean!
  isPublic: Boolean!
  isHidden: Boolean
  textFilter: [AttributeTextFilter!]
  integerRangeFilter: AttributeIntegerRangeFilter
  decimalRangeFilter: AttributeDecimalRangeFilter
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Atribute as it's defined in the Database

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Lowercased representation of the id with an attr\_ prefix that can be
used in query parameters.
The attr\_ prefix is to avoid potential naming conflict with regular
product fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The human readable description of the attribute's name.
This is a language specific value.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the attribute.
Possible values: - text - list - enum - enumlist - color - date - datetime - object - integer - decimal

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
catalog page filters.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
product specs.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute us hidden and should
only be used for background operations.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>textFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeTextFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

All available attribute text values within this search result for this particulat attribute.

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>integerRangeFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeIntegerRangeFilter</b></code>](/reference/legacy/graphql-v1/objects/attribute-integer-range-filter.mdx) <Badge class="badge badge--secondary " text="object"/>

Minumum and maximum value range for integer attributes

#### [<code style={{ fontWeight: 'normal' }}>AttributeFilter.<b>decimalRangeFilter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeDecimalRangeFilter</b></code>](/reference/legacy/graphql-v1/objects/attribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary " text="object"/>

Minumum and maximum value range for decimal attributes

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IAttributeFilter</b></code>](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`ProductsResponse`](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsResponse`](/reference/legacy/graphql-v1/objects/spare-parts-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## AttributeIntegerRangeFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-integer-range-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeIntegerRangeFilter implements IAttributeIntegerRangeFilter {
  min: Int!
  max: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeIntegerRangeFilter.<b>min</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Minumum value for this attribute

#### [<code style={{ fontWeight: 'normal' }}>AttributeIntegerRangeFilter.<b>max</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IAttributeIntegerRangeFilter</b></code>](/reference/legacy/graphql-v1/interfaces/iattribute-integer-range-filter.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## AttributeTextFilter

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-text-filter

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeTextFilter implements IAttributeTextFilter {
  value: String!
  count: Int!
  countTotal: Int
  countActive: Int
  isSelected: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeTextFilter.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The value of the attribute

#### [<code style={{ fontWeight: 'normal' }}>AttributeTextFilter.<b>count</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value with all attributes applied.

#### [<code style={{ fontWeight: 'normal' }}>AttributeTextFilter.<b>countTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value without any attribute filters applied.

#### [<code style={{ fontWeight: 'normal' }}>AttributeTextFilter.<b>countActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The number of products found with this attribute value without all attributes except it's own applied.
This can be used to display the active filter's totals

#### [<code style={{ fontWeight: 'normal' }}>AttributeTextFilter.<b>isSelected</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whehter this values is currently selected

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IAttributeTextFilter</b></code>](/reference/legacy/graphql-v1/interfaces/iattribute-text-filter.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## AttributeValueResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-value-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeValueResponse {
  items: [AttributeValue!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeValue!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type AttributeValue

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>AttributeValueResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`contactAttributeValues`](/reference/legacy/graphql-v1/queries/contact-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`customerAttributeValues`](/reference/legacy/graphql-v1/queries/customer-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productAttributeValues`](/reference/legacy/graphql-v1/queries/product-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAttributeValues`](/reference/legacy/graphql-v1/queries/user-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## AttributeValue

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute-value

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type AttributeValue {
  attributeId: Int!
  textValue(language: String): [LocalizedStringArray!]
  enumValue: [String!]
  intValue: [Int!]
  decimalValue: [Float!]
  dateValue: DateTime
  attributeDescription: AttributeDescription!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>attributeId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>textValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Textual value(s) for this attribute, filled when attribute type equals
text, list or color.
This value suitable for Localization.

##### [<code style={{ fontWeight: 'normal' }}>AttributeValue.textValue.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>enumValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Enumeration value for this attribute, filled when type equals
enum or enumlist.
Values returned from this field should be transformed used by the
valueset from the datasource field.
Values in this field can be multivalue.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>intValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Integer value for this attribute, filled when attribute type equals
numeric or object.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>decimalValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Float!]</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Decimal value for this attribute, filled when attribute type equals
decimal.

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>dateValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date value for this attribute, filled when attribute type equals
date or datetime

#### [<code style={{ fontWeight: 'normal' }}>AttributeValue.<b>attributeDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeDescription!</b></code>](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Member Of

[`AttributeValueResponse`](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Attribute

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/attribute

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Attribute {
  id: Int!
  name: String!
  searchId: String!
  description(language: String): [LocalizedString!]!
  type: AttributeType!
  typeParam: String!
  group: String!
  isSearchable: Boolean!
  isPublic: Boolean!
  isHidden: Boolean
  textValue(language: String): [LocalizedStringArray!]
  enumValue: [String!]
  intValue: [Int!]
  decimalValue: [Float!]
  dateValue: DateTime
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Attribute as it's defined in the Datebase

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Name or Id of the Attribute as it's defined in the Datebase

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>searchId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Lowercased representation of the id with an attr\_ prefix that can be
used in query parameters.
The attr\_ prefix is to avoid potential naming conflict with regular
product fields

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The human readable description of the attribute's name.
This is a language specific value.

##### [<code style={{ fontWeight: 'normal' }}>Attribute.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeType!</b></code>](/reference/legacy/graphql-v1/enums/attribute-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the attribute.
Possible values: - text - list - enum - enumlist - color - date - datetime - object - integer - decimal

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>typeParam</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the connected valueset to use when type is enum or enumlist

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>group</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The group this attribute belongs to.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>isSearchable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
catalog page filters.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>isPublic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute should be used when generating
product specs.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Flags whether this attribute us hidden and should
only be used for background operations.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>textValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Textual value(s) for this attribute, filled when attribute type equals
text, list or color.
This value suitable for Localization.

##### [<code style={{ fontWeight: 'normal' }}>Attribute.textValue.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>enumValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Enumeration value for this attribute, filled when type equals
enum or enumlist.
Values returned from this field should be transformed used by the
valueset from the datasource field.
Values in this field can be multivalue.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>intValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Integer value for this attribute, filled when attribute type equals
numeric or object.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>decimalValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Float!]</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Decimal value for this attribute, filled when attribute type equals
decimal.

#### [<code style={{ fontWeight: 'normal' }}>Attribute.<b>dateValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Date value for this attribute, filled when attribute type equals
date or datetime

### Returned By

[`productAttributes`](/reference/legacy/graphql-v1/deprecated/queries/product-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAttributes`](/reference/legacy/graphql-v1/deprecated/queries/user-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Base64File

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/base-64-file

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Base64File {
  base64: String!
  contentType: String!
  fileName: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Base64File.<b>base64</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The base64 representation of the file.

#### [<code style={{ fontWeight: 'normal' }}>Base64File.<b>contentType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The contentType of the base64 content.

#### [<code style={{ fontWeight: 'normal' }}>Base64File.<b>fileName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indication of the fileName to use when converting the base64 to a file.

### Returned By

[`orderGetPDF`](/reference/legacy/graphql-v1/queries/order-get-pdf.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## BulkPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/bulk-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type BulkPrice {
  price: Float! @deprecated
  gross: Float!
  from: Int!
  to: Int
  net(taxZone: String): Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BulkPrice.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Bulk gross price value

#### [<code style={{ fontWeight: 'normal' }}>BulkPrice.<b>from</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Starting quantity for this bulkprice

#### [<code style={{ fontWeight: 'normal' }}>BulkPrice.<b>to</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

End quantity for this bulkprice, null when inifinite

#### [<code style={{ fontWeight: 'normal' }}>BulkPrice.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>BulkPrice.net.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The taxZone used to calculate the net price. Overrules the taxZone applied to the parent field/query.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>BulkPrice.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Bulk price value deprecated in favor of 'net' and 'gross' fields



Bulk price value

</Details>

### Returned By

[`bulkPrice`](/reference/legacy/graphql-v1/queries/bulk-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BundleItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/bundle-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type BundleItem implements IBundleItem {
  productId: Int!
  price: BundlePrice
  isLeader: YesNo!
  product: Product!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BundleItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The bundles primary product identifier

#### [<code style={{ fontWeight: 'normal' }}>BundleItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundlePrice</b></code>](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary " text="object"/>

Bundle price.

#### [<code style={{ fontWeight: 'normal' }}>BundleItem.<b>isLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates whether the product is leader for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>BundleItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product!</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBundleItem</b></code>](/reference/legacy/graphql-v1/interfaces/ibundle-item.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Returned By

[`bundleAddItems`](/reference/legacy/graphql-v1/mutations/bundle-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBundle`](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## BundlePrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/bundle-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type BundlePrice implements IBundlePrice {
  net: Float
  gross: Float
  originalNet: Float
  originalGross: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BundlePrice.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Net price of the bundle after discounts applied

#### [<code style={{ fontWeight: 'normal' }}>BundlePrice.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Gross price of the bundle after discounts applied

#### [<code style={{ fontWeight: 'normal' }}>BundlePrice.<b>originalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original net price of the bundle before discounts applied

#### [<code style={{ fontWeight: 'normal' }}>BundlePrice.<b>originalGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original gross price of the bundle before discounts applied

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBundlePrice</b></code>](/reference/legacy/graphql-v1/interfaces/ibundle-price.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BundleItem`](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBundle`](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundleItem`](/reference/legacy/graphql-v1/interfaces/ibundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## Bundle

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/bundle

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Bundle implements IBundle {
  id: Float!
  comboId: Float @deprecated
  name: String!
  description: String
  discount: Float
  condition: BundleCondition
  price: BundlePrice
  items: [BundleItem!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The bundles primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The description for this bundle.

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage this bundle.

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>condition</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleCondition</b></code>](/reference/legacy/graphql-v1/enums/bundle-condition.mdx) <Badge class="badge badge--secondary " text="enum"/>

The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL).

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundlePrice</b></code>](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary " text="object"/>

The bundle prices.

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BundleItem!]</b></code>](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Items for this bundle.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Bundle.<b>comboId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



The comboId is deprecated and will be removed in the future. Please use the id field instead.



[DEPRECATED] The bundles identifier for Propeller internal use

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBundle</b></code>](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Returned By

[`bundle`](/reference/legacy/graphql-v1/queries/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`bundleCreate`](/reference/legacy/graphql-v1/mutations/bundle-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`bundles`](/reference/legacy/graphql-v1/queries/bundles.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`bundleUpdate`](/reference/legacy/graphql-v1/mutations/bundle-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessHours

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-hours

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type BusinessHours {
  dayOfWeek: Float!
  openingTime: String
  closingTime: String
  lunchBeakStartTime: String
  lunchBeakEndTime: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessHours.<b>dayOfWeek</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHours.<b>openingTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHours.<b>closingTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHours.<b>lunchBeakStartTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>BusinessHours.<b>lunchBeakEndTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleActionField

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-action-field

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Action field definition for complex field types supporting nested operations and data transformations

```graphql
type BusinessRuleActionField {
  name: [LocalizedString!]!
  path: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleActionField.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized name of the action field for user interface display and documentation

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleActionField.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

JSONPath expression defining the location of this action field within the parent complex structure

### Member Of

[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleArrayExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-array-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Array-based expression for collection operations, filtering, and element validation.

Provides logical operators for evaluating conditions across array elements including universal quantification (all),
existential quantification (some), negation (none), and membership testing (contains).
Supports both simple value matching and complex nested expressions for comprehensive array processing.

```graphql
type BusinessRuleArrayExpression implements IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
  operator: BusinessRuleArrayExpressionOperators!
  string: String
  number: Float
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleArrayExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-array-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Logical operator defining how the condition should be applied to array elements

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

String value to match against array elements (used with 'contains' operator for simple value matching)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Numeric value to match against array elements (used with 'contains' operator for simple value matching)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleArrayExpression.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/array for options.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleExpression</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

---

## BusinessRuleComplexExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-complex-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Advanced expression combining multiple sub-expressions with aggregation functions.

Enables complex data processing by filtering collections based on multiple criteria and then applying aggregation operations.
Supports mathematical operations (sum), counting operations (count), and data collection (collect) on filtered datasets.

```graphql
type BusinessRuleComplexExpression implements IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
  operator: BusinessRuleNumberExpressionOperators
  action: BusinessRuleComplexExpressionAction!
  field: String
  path: String
  number: Float!
  expressions: [BusinessRuleSubExpressionGroup!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNumberExpressionOperators</b></code>](/reference/legacy/graphql-v1/enums/business-rule-number-expression-operators.mdx) <Badge class="badge badge--secondary " text="enum"/>

Optional numeric comparison operator for evaluating the aggregated result against a threshold value

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>action</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleComplexExpressionAction!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-complex-expression-action.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Aggregation function to apply to the filtered data collection.

- 'sum': Calculate the sum of numeric values from a specific field in filtered elements
- 'count': Count the number of elements that match the filtering criteria
- 'collect': Gather and return all matching elements as a collection

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

JSONPath to the specific field for sum operations (e.g., '$.price' to sum price values from filtered elements)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

JSONPath expression defining the target data collection for filtering and aggregation.

Defaults to '$' (root field) when omitted. Must be specified when used as a sub-expression within larger expressions.
Examples: '$.orders', '$.items[&#x002A;]', '$.customer.purchases'

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Numeric threshold value for comparison when using the operator (e.g., count &#x003E; 5, sum &#x003E;= 100)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleComplexExpression.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleSubExpressionGroup!]</b></code>](/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleExpression</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

---

## BusinessRuleDateExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-date-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Date and time expression for temporal comparisons and date-specific operations.

Provides comprehensive temporal comparison capabilities including absolute date comparisons, relative date calculations, and time-based conditions.
Supports both date-only and datetime operations with flexible offset calculations from current time.

```graphql
type BusinessRuleDateExpression implements IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
  number: Int
  date: DateTime
  string: String
  operator: BusinessRuleDateExpressionOperators!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Numeric offset value for relative date calculations.

Used with operators that calculate relative dates:

- Days from today (positive for future, negative for past)
- Minutes from now for precise time calculations
- Day of week (1-7, Monday=1), day of month (1-31), month of year (1-12)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Absolute date value for direct date comparisons (used with 'before' and 'after' operators)

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Time value in 24-hour format (HH:MM:SS) for time-based operators like 'onTime', 'beforeTime', 'afterTime'

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDateExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-date-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Temporal comparison operator defining how the date/time value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDateExpression.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/date-and-time for options.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleExpression</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

---

## BusinessRuleDecisionTableCell

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Individual data cell within a decision table row containing conditions or actions.

Cells can contain different types of values depending on their purpose:

- Expressions for complex conditional logic and calculations
- String values for text-based results and identifiers
- Numeric values for mathematical operations and quantities
- Localized strings for multi-language support and internationalization

```graphql
type BusinessRuleDecisionTableCell {
  columnId: ID!
  expression: BusinessRuleExpressionGroup
  value: String
  localizedValue: [LocalizedString!]
  number: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableCell.<b>columnId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the column this cell belongs to, linking it to the table's column definition

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableCell.<b>expression</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroup</b></code>](/reference/legacy/graphql-v1/objects/business-rule-expression-group.mdx) <Badge class="badge badge--secondary " text="object"/>

Complex expression group containing conditional logic, comparisons, and calculations for rule evaluation

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableCell.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Text value for output cells supporting both literal strings and expression syntax.

Literal strings must be wrapped in quotes (e.g., "Hello World").
Expression syntax allows dynamic content generation and variable substitution.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableCell.<b>localizedValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Multi-language text values for internationalized output generation.

Enables rules to produce localized content based on user preferences or regional requirements.
Each entry contains a language code and corresponding translated text.

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableCell.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Numeric value for mathematical calculations, quantities, and numerical output generation

### Member Of

[`BusinessRuleDecisionTableRow`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-row.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleDecisionTableContent

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-decision-table-content

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Core content structure of a decision table containing the business logic rules and column definitions

```graphql
type BusinessRuleDecisionTableContent {
  hitPolicy: BusinessRuleHitPolicyOption!
  rows: [BusinessRuleDecisionTableRow!]!
  inputs: [BusinessRuleDecisionTableInputOutput!]!
  outputs: [BusinessRuleDecisionTableInputOutput!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableContent.<b>hitPolicy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleHitPolicyOption!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-hit-policy-option.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Execution strategy determining how multiple matching rules are handled.

'first' - Execute only the first matching rule and stop processing
'collect' - Execute all matching rules and aggregate their results

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableContent.<b>rows</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleDecisionTableRow!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-row.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of rule rows, each containing conditions and corresponding actions for business logic execution

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableContent.<b>inputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleDecisionTableInputOutput!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-input-output.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Input column definitions specifying the data fields and conditions to be evaluated

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableContent.<b>outputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleDecisionTableInputOutput!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-input-output.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Output column definitions specifying the result fields and actions to be executed

### Member Of

[`BusinessRuleDecisionTable`](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleDecisionTableInputOutput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-decision-table-input-output

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Column definition for decision table inputs and outputs specifying data structure and field mapping.

Input columns define the data fields that will be evaluated against rule conditions.
Output columns define the result fields that will be populated when rules are executed.
Supports hierarchical field organization using dot notation for complex data structures.

```graphql
type BusinessRuleDecisionTableInputOutput {
  id: ID!
  name: String!
  field: String!
  type: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableInputOutput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this column definition within the decision table

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableInputOutput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Human-readable name of the column for identification and documentation purposes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableInputOutput.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Data field path specification for input evaluation or output generation.

Input columns: Full path from the root of the input payload (e.g., "order.customer.email")
Output columns: Target field name for result population, supports nested structure with dot notation

Examples:

- Input: "order.items[0].price" - Access first item's price
- Output: "result.discount.amount" - Set discount amount in nested result structure
- Output: "customer.loyaltyPoints" - Update customer loyalty points

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableInputOutput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Column data type classification, currently supports "expression" for dynamic content evaluation

### Member Of

[`BusinessRuleDecisionTableContent`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-content.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleDecisionTableRow

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-decision-table-row

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Individual rule within a decision table containing conditions and corresponding actions.

Each row represents a complete business rule with input conditions that must be met and output actions that will be executed.
Rows are evaluated in sequence according to the table's hit policy, enabling complex decision logic and conditional processing.

```graphql
type BusinessRuleDecisionTableRow {
  id: ID!
  inputs: [BusinessRuleDecisionTableCell!]!
  outputs: [BusinessRuleDecisionTableCell!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableRow.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this rule row within the decision table

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableRow.<b>inputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleDecisionTableCell!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Input condition cells containing expressions and criteria that must be satisfied for this rule to execute

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTableRow.<b>outputs</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleDecisionTableCell!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Output action cells containing the results and actions to be executed when this rule's conditions are met

### Member Of

[`BusinessRuleDecisionTableContent`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-content.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleDecisionTable

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-decision-table

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

```graphql
type BusinessRuleDecisionTable implements IBusinessRuleNode {
  type: BusinessRuleNodeType!
  id: ID!
  name: String!
  description: String!
  content: BusinessRuleDecisionTableContent!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTable.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNodeType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-node-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Node type identifier, always 'decisionTableNode' for decision processing nodes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTable.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this decision table node within the business rule graph

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTable.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Descriptive name of the decision table indicating its business purpose and scope

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTable.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Detailed explanation of the decision table's logic, conditions, and expected outcomes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleDecisionTable.<b>content</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableContent!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table-content.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Complete table structure containing rows, columns, and execution policy for the business rule logic

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleNode</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule node types defining common properties and behavior.

Nodes are the fundamental processing units within a business rule graph, each serving a specific function:

- Input nodes receive and validate incoming data
- Decision table nodes contain the core business logic and rules
- Output nodes format and return the final results
- Function nodes execute custom computational logic

### Returned By

[`businessRuleDecisionTable`](/reference/legacy/graphql-v1/queries/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`businessRuleDecisionTableAddColumn`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-column.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableAddRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-add-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableDeleteColumn`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-column.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableDeleteRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-delete-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableMoveRow`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-move-row.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableSetCell`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-set-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDecisionTableUpdate`](/reference/legacy/graphql-v1/mutations/business-rule-decision-table-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## BusinessRuleEdge

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-edge

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Directed connection between business rule nodes that defines data flow and execution sequence.

Edges establish the pathway for data transformation as it moves through the business rule graph,
ensuring proper sequencing of operations and maintaining data integrity throughout the processing pipeline.
Most commonly, graphs contain an input node connected to a decision table node, which then connects to an output node.

```graphql
type BusinessRuleEdge {
  id: ID!
  sourceId: ID!
  targetId: ID!
  type: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleEdge.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this edge connection within the business rule graph

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleEdge.<b>sourceId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the source node where data originates and flows from

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleEdge.<b>targetId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the target node where data flows to and gets processed

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleEdge.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Connection type classifier, currently supports 'edge' for standard data flow connections

### Member Of

[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleExpressionGroup

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-expression-group

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Logical grouping of multiple expressions combined with AND/OR operators.

Enables complex conditional logic by combining multiple individual expressions with logical operators.
Supports nested grouping for sophisticated business rule conditions and hierarchical decision making.

```graphql
type BusinessRuleExpressionGroup {
  id: ID!
  expressions: [IBusinessRuleExpression!]!
  operator: BusinessRuleExpressionGroupOperators
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroup.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression group within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroup.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBusinessRuleExpression!]!</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

Collection of individual expressions that will be combined using the group's logical operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleExpressionGroup.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroupOperators</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-group-operators.mdx) <Badge class="badge badge--secondary " text="enum"/>

Logical operator combining all expressions in this group (AND requires all true, OR requires at least one true)

### Member Of

[`BusinessRuleDecisionTableCell`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleFieldDefinitionGroup

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-field-definition-group

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Collection of related field definitions organized by domain context for business rule mapping.

Groups field definitions by logical domains (e.g., order, customer, product) to provide organized access to available fields.
Supports hierarchical organization with root groups and nested structures for complex data modeling.

```graphql
type BusinessRuleFieldDefinitionGroup {
  id: ID!
  name: String!
  isRoot: Boolean!
  definitions: [BusinessRuleFieldDefinition!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinitionGroup.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this field definition group within the system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinitionGroup.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Domain name of the field definition group (e.g., 'order', 'customer', 'product')

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinitionGroup.<b>isRoot</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether this group represents a top-level domain or a nested sub-group

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinitionGroup.<b>definitions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleFieldDefinition!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of field definitions available within this domain group for business rule construction

### Returned By

[`businessRuleFieldDefinitions`](/reference/legacy/graphql-v1/queries/business-rule-field-definitions.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## BusinessRuleFieldDefinition

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-field-definition

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Field definition template for business rule input and output mapping.

Defines the structure, data type, and validation rules for fields that can be used in business rule expressions.
Supports hierarchical field organization with nested sub-fields and complex data structures for comprehensive rule modeling.

```graphql
type BusinessRuleFieldDefinition {
  id: ID!
  name: [LocalizedString!]!
  path: String!
  type: BusinessRuleExpressionTypes!
  fields: [BusinessRuleActionField!]
  expressions: [BusinessRuleFieldDefinition!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this field definition within the system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Human-readable name of the field in multiple languages for international support

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

JSONPath expression defining the location of this field within the data structure (e.g., 'order.customer.email')

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type of the field determining available operations and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>fields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleActionField!]</b></code>](/reference/legacy/graphql-v1/objects/business-rule-action-field.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Available action fields for complex types that support nested operations and transformations

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleFieldDefinition.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleFieldDefinition!]</b></code>](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Nested field definitions for complex types enabling hierarchical data structure modeling

### Member Of

[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinitionGroup`](/reference/legacy/graphql-v1/objects/business-rule-field-definition-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRuleInput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-input

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Input node that serves as the entry point for data into the business rule execution flow

```graphql
type BusinessRuleInput implements IBusinessRuleNode {
  type: BusinessRuleNodeType!
  id: ID!
  name: String!
  description: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleInput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNodeType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-node-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Node type identifier, always 'inputNode' for input processing nodes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleInput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this input node within the business rule graph

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleInput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Descriptive name of the input node indicating the type of data it processes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleInput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Detailed explanation of the input node's data requirements and validation rules

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleNode</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule node types defining common properties and behavior.

Nodes are the fundamental processing units within a business rule graph, each serving a specific function:

- Input nodes receive and validate incoming data
- Decision table nodes contain the core business logic and rules
- Output nodes format and return the final results
- Function nodes execute custom computational logic

---

## BusinessRuleNumberExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-number-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Numeric expression for mathematical comparisons, calculations, and range validations.

Provides comprehensive numeric comparison capabilities including equality, inequality, and range operations.
Supports integer and decimal values for precise mathematical business rule conditions and calculations.

```graphql
type BusinessRuleNumberExpression implements IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
  operator: BusinessRuleNumberExpressionOperators!
  number: Float!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpression.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNumberExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-number-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Mathematical comparison operator defining how the numeric value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpression.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Numeric value to compare against the target field using the specified operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleNumberExpression.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calculations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/number for options.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleExpression</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

---

## BusinessRuleOutput

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-output

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Output node that formats and returns the final results after business rule processing

```graphql
type BusinessRuleOutput implements IBusinessRuleNode {
  type: BusinessRuleNodeType!
  id: ID!
  name: String!
  description: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleOutput.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleNodeType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-node-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Node type identifier, always 'outputNode' for result generation nodes

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleOutput.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this output node within the business rule graph

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleOutput.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Descriptive name of the output node indicating the type of results it generates

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleOutput.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Detailed explanation of the output node's result structure and formatting rules

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleNode</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule node types defining common properties and behavior.

Nodes are the fundamental processing units within a business rule graph, each serving a specific function:

- Input nodes receive and validate incoming data
- Decision table nodes contain the core business logic and rules
- Output nodes format and return the final results
- Function nodes execute custom computational logic

---

## BusinessRuleResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response container for business rule search queries with metadata.

Provides structured access to business rule collections with pagination support,
including total count information and navigation metadata for efficient data browsing and API consumption.

```graphql
type BusinessRuleResponse {
  items: [BusinessRule!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRule!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type BusinessRule

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`businessRules`](/reference/legacy/graphql-v1/queries/business-rules.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## BusinessRuleStringExpression

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-string-expression

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

String-based expression for text matching, pattern recognition, and string operations.

Provides comprehensive string comparison capabilities including exact matching, pattern matching, and array membership testing.
Supports case-sensitive operations and various string manipulation functions for flexible text-based business rule conditions.

```graphql
type BusinessRuleStringExpression implements IBusinessRuleExpression {
  id: ID!
  type: BusinessRuleExpressionTypes!
  operator: BusinessRuleStringExpressionOperators!
  string: String!
  path: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpression.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this expression within the business rule system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpression.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionTypes!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Data type classification of the expression determining available operators and validation rules

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpression.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleStringExpressionOperators!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-string-expression-operators.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

String comparison operator defining how the string value should be evaluated against the target field

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpression.<b>string</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Text value to compare against the target field using the specified operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleStringExpression.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Path to the field, can be used to add additional expressions and calulations on the field.
Use $ to target the field's value.
When omitted the field's value is used.
The expression will be used on the left hand side of the operator.
Can also be used to target a specific property in a complex expression's sub-expression
Check https://gorules.io/docs/rules-engine/expression-language/string for options.

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBusinessRuleExpression</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary " text="interface"/>

Base interface for all business rule expression types defining common properties and behavior.

Expressions are the fundamental building blocks for business rule conditions and calculations.
Each expression type provides specific operators and validation logic for different data types including strings, numbers, dates, arrays, and complex aggregations.

---

## BusinessRuleSubExpressionGroup

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Nested expression group for complex filtering within parent expressions.

Provides hierarchical expression organization for advanced business rule logic.
Used within complex expressions to define sophisticated filtering criteria with multiple levels of conditional logic.

```graphql
type BusinessRuleSubExpressionGroup {
  id: ID!
  field: String!
  expressions: [IBusinessRuleExpression!]!
  operator: BusinessRuleExpressionGroupOperators
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSubExpressionGroup.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this sub-expression group within the parent expression context

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSubExpressionGroup.<b>field</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

JSONPath to the field that this sub-expression group will evaluate against (e.g., '$.items[&#x002A;].category')

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSubExpressionGroup.<b>expressions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBusinessRuleExpression!]!</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

Collection of nested expressions that will be combined using the group's logical operator

#### [<code style={{ fontWeight: 'normal' }}>BusinessRuleSubExpressionGroup.<b>operator</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleExpressionGroupOperators</b></code>](/reference/legacy/graphql-v1/enums/business-rule-expression-group-operators.mdx) <Badge class="badge badge--secondary " text="enum"/>

Logical operator combining all nested expressions (AND requires all true, OR requires at least one true)

### Member Of

[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## BusinessRule

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/business-rule

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

```graphql
type BusinessRule {
  id: ID!
  shopId: Int! @deprecated
  type: BusinessRuleType!
  name: [LocalizedString!]!
  edges: [BusinessRuleEdge!]!
  nodes: [IBusinessRuleNode!]!
  createdAt: DateTime!
  updatedAt: DateTime!
  jdm: JSONObject!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for the business rule within the system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleType!</b></code>](/reference/legacy/graphql-v1/enums/business-rule-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Classification of the business rule determining its domain context and application scope

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Human-readable name of the business rule in multiple languages for international support

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>edges</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessRuleEdge!]!</b></code>](/reference/legacy/graphql-v1/objects/business-rule-edge.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Directed connections between nodes that define the execution flow and data path through the rule graph

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>nodes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBusinessRuleNode!]!</b></code>](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

Processing nodes in the rule graph including input receivers, decision tables, and output generators

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the business rule was initially created in the system

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>updatedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp of the most recent modification to the business rule configuration or logic

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>jdm</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject!</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Generate the JSON Decision Model (JDM) representation of this business rule for execution engines.

Returns the standardized JDM format containing all rule logic, conditions, and actions required for runtime execution in compatible rule engines.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>BusinessRule.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Shop is deprecated and will be removed in a future version



[DEPRECATED] Store or shop identifier that owns this business rule, used for multi-tenant rule management

</Details>

### Returned By

[`businessRule`](/reference/legacy/graphql-v1/queries/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`businessRuleCreate`](/reference/legacy/graphql-v1/mutations/business-rule-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleUpdate`](/reference/legacy/graphql-v1/mutations/business-rule-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`incentiveRuleCreate`](/reference/legacy/graphql-v1/mutations/incentive-rule-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`incentiveRuleSetAction`](/reference/legacy/graphql-v1/mutations/incentive-rule-set-action.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`incentiveRuleSetOrderItemConditions`](/reference/legacy/graphql-v1/mutations/incentive-rule-set-order-item-conditions.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`BusinessRuleResponse`](/reference/legacy/graphql-v1/objects/business-rule-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Carrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

```graphql
type Carrier {
  id: Int!
  name: String!
  type: CarrierType!
  descriptions: [LocalizedString!]
  shippingCost: Float! @deprecated
  trackAndTraceURL: String
  logo: String
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  warehouses: [Warehouse!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for the shipping carrier.

    Primary key used to reference this carrier throughout the system and for shipping operations.

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipping carrier company name.

    Official name of the shipping company or service provider used for display in shipping options and logistics management.

    Constraints:
    - Must be unique within the organization
    - Cannot exceed 64 characters

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarrierType!</b></code>](/reference/legacy/graphql-v1/enums/carrier-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Type of shipping service offered by the carrier.

    Defines the delivery method and service characteristics provided by this carrier (e.g., pickup, delivery, express).

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Localized carrier descriptions for different languages.

    Collection of carrier service descriptions in various languages for international shipping options and multilingual storefronts.

    Constraints:
    - Each description must have a unique 2-character language code
    - Language codes must be uppercase (e.g., EN, DE, FR)
    - Text values can contain up to 255 characters

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>trackAndTraceURL</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Package tracking URL template for shipment monitoring.

    URL template used to generate tracking links for packages shipped with this carrier. May include placeholders for tracking numbers and other shipment details.

    Constraints:
    - Must be a valid HTTPS URL
    - Cannot exceed 255 characters
    - May include query parameters and placeholders

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Carrier logo URL for branding in shipping options.

    URL pointing to the carrier's logo image used for branding in shipping options and customer-facing interfaces.

    Constraints:
    - Must be a valid URL
    - Cannot exceed 255 characters
    - Recommended: Maximum file size of 200kB
    - Recommended: Dimensions of 200x200px

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Date and time when the carrier was created.

    Timestamp indicating when this carrier was first added to the system. Used for auditing, filtering, and tracking carrier lifecycle. Always in UTC format.

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Date and time when the carrier was last modified.

    Timestamp indicating when this carrier was most recently updated in the system. Used for auditing, filtering, and tracking carrier changes. Always in UTC format.

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>createdBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the user who created this carrier.

    References the user account that originally created this carrier record. Used for auditing and tracking carrier ownership. May be null for system-created carriers.

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>lastModifiedBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the user who last modified this carrier.

    References the user account that most recently updated this carrier record. Used for auditing and tracking carrier changes. May be null for system-updated carriers.

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>warehouses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Warehouse!]</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Carrier.<b>shippingCost</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favour of Propeller's business rule builder, where logic can be set up for carriers and more complex use cases



Base shipping cost for this carrier (deprecated).

    Fixed shipping cost associated with this carrier. This field is deprecated in favor of Propeller's business rule builder for more flexible and complex pricing logic.

    Constraints:
    - Decimal precision: 10 digits total, 5 decimal places
    - Must be a positive value

</Details>

### Returned By

[`carrier`](/reference/legacy/graphql-v1/queries/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`carrierAssignWarehouseAndReturnCarrier`](/reference/legacy/graphql-v1/mutations/carrier-assign-warehouse-and-return-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierCreate`](/reference/legacy/graphql-v1/mutations/carrier-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierUnassignWarehouseAndReturnCarrier`](/reference/legacy/graphql-v1/mutations/carrier-unassign-warehouse-and-return-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierUpdate`](/reference/legacy/graphql-v1/mutations/carrier-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CarriersResponse`](/reference/legacy/graphql-v1/objects/carriers-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TrackAndTrace`](/reference/legacy/graphql-v1/objects/track-and-trace.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CarriersResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/carriers-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing carrier search results.

Provides a structured response for carrier search operations including the matching carriers, pagination metadata, and result statistics. Used to deliver carrier data with comprehensive pagination support.

```graphql
type CarriersResponse {
  items: [Carrier!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Carrier!]!</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Carrier

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>CarriersResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`carriers`](/reference/legacy/graphql-v1/queries/carriers.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## CartAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartAddress {
  company: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  code: String
  email: String
  mobile: String
  phone: String
  url: String
  icp: YesNo
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The company name

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Gender.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

First name.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Middle name.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Last name.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Street name.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

House number.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

House number extension.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Postal code.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

City.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Region.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Country.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Code.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Mobile.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Phone.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Url.

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Marks wether this address is an ICP address

#### [<code style={{ fontWeight: 'normal' }}>CartAddress.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address notes.

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartBaseItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-base-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartBaseItem implements ICartBaseItem {
  id: Int!
  notes: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  sum: Float!
  sumNet: Float!
  totalSum: Float!
  totalSumNet: Float!
  quantity: Int!
  bundleId: Int
  productId: Int
  taxCode: Taxcode!
  expectedDeliveryDate: DateTime
  deliveryDeadline: DateTime
  discount: Float!
  discountPercentage: Float!
  surcharges: [CartItemSurcharge!]!
  product: Product!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the cart item, this id can be used for update or delete mutation for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on cart item level

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>sum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>sumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>totalSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>totalSumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>bundleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's bundleId if applicable

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's productId if applicable

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expected delivery date for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>deliveryDeadline</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>surcharges</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartItemSurcharge!]!</b></code>](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The surcharges applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartBaseItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product!</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ICartBaseItem</b></code>](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartCarrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartCarrier {
  name: String!
  description: String!
  logo: String!
  price: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartCarrier.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier name

#### [<code style={{ fontWeight: 'normal' }}>CartCarrier.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier description

#### [<code style={{ fontWeight: 'normal' }}>CartCarrier.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier's logo

#### [<code style={{ fontWeight: 'normal' }}>CartCarrier.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The targeted costs for delivery through this carrier. Use the costs as an indication, the actual costs are calculated through business rules

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartDeleteResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-delete-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartDeleteResponse {
  message: String!
  success: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartDeleteResponse.<b>message</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartDeleteResponse.<b>success</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`cartDelete`](/reference/legacy/graphql-v1/mutations/cart-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartIncentive

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-incentive

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartIncentive {
  ruleId: Int!
  name: String!
  content: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartIncentive.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ruleId that the incentive derived from

#### [<code style={{ fontWeight: 'normal' }}>CartIncentive.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the incentive

#### [<code style={{ fontWeight: 'normal' }}>CartIncentive.<b>content</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The content of the incentive's desccription

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartItemSurcharge

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-item-surcharge

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartItemSurcharge {
  code: String!
  quantity: Int!
  taxCode: Taxcode!
  taxZone: String!
  amount: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartItemSurcharge.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Code

#### [<code style={{ fontWeight: 'normal' }}>CartItemSurcharge.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Quantity

#### [<code style={{ fontWeight: 'normal' }}>CartItemSurcharge.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Tax code

#### [<code style={{ fontWeight: 'normal' }}>CartItemSurcharge.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Taxzone

#### [<code style={{ fontWeight: 'normal' }}>CartItemSurcharge.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Amount

### Member Of

[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartMainItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-main-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartMainItem implements ICartBaseItem {
  id: Int!
  productId: Int
  bundleId: Int
  bundle(taxZone: String = "NL"): Bundle
  notes: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  sum: Float!
  sumNet: Float!
  totalSum: Float!
  totalSumNet: Float!
  quantity: Int!
  taxCode: Taxcode!
  expectedDeliveryDate: DateTime
  deliveryDeadline: DateTime
  discount: Float!
  discountPercentage: Float!
  surcharges: [CartItemSurcharge!]!
  childItems: [CartBaseItem!]
  product: Product
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the cart item, this id can be used for update or delete mutation for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's productId if applicable

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>bundleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cart item's bundleId if applicable

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>bundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Bundle</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>CartMainItem.bundle.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on cart item level

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net price per UOM of this cart item, no item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net price for this cart item, including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>sum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>sumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The net sum of the main cart price and the prices of its child items per UOM. No item specific discounts are applied to this price.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>totalSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>totalSumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total net sum of the main cart price and the prices of its child items. Including item specific discounts.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expected delivery date for this cart item.

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>deliveryDeadline</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount percentage applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>surcharges</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartItemSurcharge!]!</b></code>](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The surcharges applied to this cart item

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>childItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartBaseItem!]</b></code>](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>CartMainItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ICartBaseItem</b></code>](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartPaymentData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-payment-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartPaymentData {
  netAmount: Float!
  grossAmount: Float!
  tax: Float!
  taxPercentage: Float!
  method: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentData.<b>netAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected paymethod on this cart. Including VAT.

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentData.<b>grossAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected paymethod on this cart. Excluding VAT.

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentData.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax associated with the selected paymethod on this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentData.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage associated with the selected paymethod on this cart.

#### [<code style={{ fontWeight: 'normal' }}>CartPaymentData.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected paymethod for this cart. Defaults to REKENING.

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartPaymethod

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-paymethod

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartPaymethod {
  description: String!
  code: String!
  externalCode: String!
  type: String!
  taxCode: Taxcode!
  price: Float!
  amount: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>externalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPaymethod.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartPostageData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-postage-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartPostageData {
  shippingMethod: String!
  postageTaxPercentage: Float!
  requestDate: DateTime!
  postage: Float!
  postageNet: Float!
  priceMode: PriceMode!
  partialDeliveryAllowed: YesNo
  pickUpLocationId: Int
  warehouse: Warehouse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>shippingMethod</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected shipping method for this cart. Defaults to VERZENDEN.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>postageTaxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>postage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected shipping method and business rules that apply to this cart. Excluding VAT.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>postageNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected shipping method and business rules that apply to this cart. Including VAT.

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>priceMode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceMode!</b></code>](/reference/legacy/graphql-v1/enums/price-mode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates where the price is calculated. PLATFORM - Price was calculated based on product price/postage rules set in Propeller. EXTERNAL - price was set externally

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

This order can be shipped in parts when items different delivery dates

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pick up location ID

#### [<code style={{ fontWeight: 'normal' }}>CartPostageData.<b>warehouse</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartProcessResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-process-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartProcessResponse {
  cartOrderId: Int!
  response: CartResponseData!
  order: Order!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartProcessResponse.<b>cartOrderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartProcessResponse.<b>response</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartResponseData!</b></code>](/reference/legacy/graphql-v1/objects/cart-response-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>CartProcessResponse.<b>order</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Order!</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`cartProcess`](/reference/legacy/graphql-v1/mutations/cart-process.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartResponseData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-response-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartResponseData {
  data: JSONObject!
  error: Boolean!
  messages: [String!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartResponseData.<b>data</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject!</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartResponseData.<b>error</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CartResponseData.<b>messages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`CartProcessResponse`](/reference/legacy/graphql-v1/objects/cart-process-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartResponse`](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CartResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartResponse {
  cart: Cart!
  response: CartResponseData!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartResponse.<b>cart</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Cart!</b></code>](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>CartResponse.<b>response</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartResponseData!</b></code>](/reference/legacy/graphql-v1/objects/cart-response-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`cartAddActionCode`](/reference/legacy/graphql-v1/mutations/cart-add-action-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartAddBundle`](/reference/legacy/graphql-v1/mutations/cart-add-bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartAddItem`](/reference/legacy/graphql-v1/mutations/cart-add-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartAddVoucherCode`](/reference/legacy/graphql-v1/mutations/cart-add-voucher-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartDeleteItem`](/reference/legacy/graphql-v1/mutations/cart-delete-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartRemoveActionCode`](/reference/legacy/graphql-v1/mutations/cart-remove-action-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartRemoveVoucherCode`](/reference/legacy/graphql-v1/mutations/cart-remove-voucher-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartSetUser`](/reference/legacy/graphql-v1/mutations/cart-set-user.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartUpdate`](/reference/legacy/graphql-v1/mutations/cart-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartUpdateAddress`](/reference/legacy/graphql-v1/mutations/cart-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartUpdateItem`](/reference/legacy/graphql-v1/mutations/cart-update-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartUpdateItems`](/reference/legacy/graphql-v1/mutations/cart-update-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CartTaxLevel

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-tax-level

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartTaxLevel {
  taxCode: Taxcode!
  price: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartTaxLevel.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax level's tax code

#### [<code style={{ fontWeight: 'normal' }}>CartTaxLevel.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total tax added for to the cart for the tax level's tax code

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartTotal

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-total

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartTotal {
  subTotal: Float!
  subTotalNet: Float!
  discountPercentage: Float!
  totalNet: Float!
  totalGross: Float!
  discountNet: Float!
  discountGross: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>subTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount of all items in this cart,
so excluding postageCosts, paymethodsCosts and discounts. Excluding VAT

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>subTotalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount of all items in this cart,
so excluding postageCosts, paymethodsCosts and discounts. Including VAT

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount percentage that is applied to the order total through one or multiple incentives.

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>totalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount for this cart. Including VAT

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>totalGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount for this cart. Excluding VAT

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>discountNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount that is applied to the order total through one or multiple incentives. Including VAT.

#### [<code style={{ fontWeight: 'normal' }}>CartTotal.<b>discountGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount that is applied to the order total through one or multiple incentives. Excluding VAT.

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## CartVoucher

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart-voucher

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CartVoucher {
  code: String!
  name: String!
  description: String!
  ruleId: Int!
  redeemed: YesNo!
  combinable: YesNo!
  partialRedemption: YesNo!
  available: Float!
  remaining: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The voucher's code

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the rule that generated this voucher

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The description of the rule that generated this voucher

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>ruleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the rule that generated this voucher

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>redeemed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is this voucher already redeemed

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>combinable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Can this voucher be combined with other vouchers

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>partialRedemption</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Can this voucher be partially redeemed when type is a payable amount

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>available</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The available amount when the voucher represents a payable amount

#### [<code style={{ fontWeight: 'normal' }}>CartVoucher.<b>remaining</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The remaining amount when the voucher represent a payable amount and can be partially redeemed

### Member Of

[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## Cart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cart

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Cart implements ICart {
  cartId: String!
  userId: Int!
  channelId: Int
  carrier: String!
  notes: String
  reference: String
  extra3: String
  extra4: String
  orderStatus: String
  actionCode: String
  couponCode: String
  vouchers: [CartVoucher!]
  paymentData: CartPaymentData
  postageData: CartPostageData
  total: CartTotal
  items: [CartMainItem!]
  bonusItems: [CartBaseItem!]
  invoiceAddress: CartAddress!
  deliveryAddress: CartAddress!
  taxLevels: [CartTaxLevel!]
  payMethods: [CartPaymethod!]
  carriers: [CartCarrier!]
  dateCreated: DateTime
  dateChanged: DateTime
  incentives: [CartIncentive!]
  valuePoints: Int
  user: IBaseUser!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The carts primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The userId for this cart. The userId can only be set once.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The channel identifier this cart belongs to.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's remarks for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's reference for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a cart and order.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>orderStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Status of the order after processing the cart. When order status is UNFINISHED, the cart is pending payment from PSP.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ActionCode that is applied to this cart. Is only filled when an valid action is applied

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>couponCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

CouponCode that is applied to this cart. Is only filled when an valid couponCode is applied

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>vouchers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartVoucher!]</b></code>](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Array of applied voucherCodes that are applied to this cart. Is only filled when an valid action is applied

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPaymentData</b></code>](/reference/legacy/graphql-v1/objects/cart-payment-data.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartPostageData</b></code>](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary " text="object"/>

Postage data for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartTotal</b></code>](/reference/legacy/graphql-v1/objects/cart-total.mdx) <Badge class="badge badge--secondary " text="object"/>

Totals for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartMainItem!]</b></code>](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The carts main items

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>bonusItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartBaseItem!]</b></code>](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

BonusItems that are added to this cart through incentives.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>invoiceAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddress!</b></code>](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The address the invoice for the order should be send to.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>deliveryAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CartAddress!</b></code>](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The address the order should be send to.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>taxLevels</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartTaxLevel!]</b></code>](/reference/legacy/graphql-v1/objects/cart-tax-level.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Amount of tax that applies to this cart per tax code

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>payMethods</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartPaymethod!]</b></code>](/reference/legacy/graphql-v1/objects/cart-paymethod.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable paymethods for this cart and applied user.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>carriers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartCarrier!]</b></code>](/reference/legacy/graphql-v1/objects/cart-carrier.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable carriers for this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date this cart has been created.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>dateChanged</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date this cart has been last updated.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>incentives</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CartIncentive!]</b></code>](/reference/legacy/graphql-v1/objects/cart-incentive.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

All incentives that apply to this cart.

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this cart

#### [<code style={{ fontWeight: 'normal' }}>Cart.<b>user</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ICart</b></code>](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Returned By

[`cartStart`](/reference/legacy/graphql-v1/mutations/cart-start.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CartResponse`](/reference/legacy/graphql-v1/objects/cart-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CategoryResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/category-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CategoryResponse {
  items: [Category!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Category!]!</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Category

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>CategoryResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`categories`](/reference/legacy/graphql-v1/queries/categories.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## Category

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/category

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Category {
  id: Int! @deprecated
  categoryId: Int!
  attributeValues(filter: AttributeFilterInput): AttributeValueResponse!
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]!
  slug(language: String): [LocalizedString!]!
  path: String!
  categories: [Category!]
  parent: Category
  defaultLanguage: String!
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  categoryPath: [Category!]!
  products(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    getDescendants: Boolean = true
    sku: [String!]
  ): ProductsResponse!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>Category.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized category name as it is available in
the supported language defaults to the category's default language.

##### [<code style={{ fontWeight: 'normal' }}>Category.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The long description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>Category.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The short description for this category,
this field can contain html formatting,
this field can be translated is case of multilingual catalog

##### [<code style={{ fontWeight: 'normal' }}>Category.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The slug for this category,
each available language contains a different slug

##### [<code style={{ fontWeight: 'normal' }}>Category.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The path in id's to the root of the inheritance tree,
can be passed as parameter to the productsearch API

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>categories</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Category!]</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>parent</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Category</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="object"/>

The category's parent Category when available

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>categoryPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Category!]!</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductsResponse!</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products of this category (false)

##### [<code style={{ fontWeight: 'normal' }}>Category.products.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Category.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use categoryId instead.



</Details>

### Returned By

[`category`](/reference/legacy/graphql-v1/queries/category.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`categoryCreate`](/reference/legacy/graphql-v1/mutations/category-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`categoryUpdate`](/reference/legacy/graphql-v1/mutations/category-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CategoryResponse`](/reference/legacy/graphql-v1/objects/category-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Channel

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/channel

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Channel {
  shop: Shop
  channelId: Int!
  id: Int!
  name: String!
  catalogRootId: Int
  defaultLetterId: Int
  anonymousUserId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>shop</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Shop</b></code>](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>catalogRootId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Catalog root id

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>defaultLetterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Channel default letter id

#### [<code style={{ fontWeight: 'normal' }}>Channel.<b>anonymousUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Channel anonymous user id

### Returned By

[`channel`](/reference/legacy/graphql-v1/queries/channel.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`channels`](/reference/legacy/graphql-v1/queries/channels.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ClusterDrillDown

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cluster-drill-down

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ClusterDrillDown implements IClusterDrillDown {
  attributeId: String!
  attribute: AttributeDescription
  priority: Int!
  displayType: ClusterDrillDownDisplayTypes!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDown.<b>attributeId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the Attribute to create the drilldown matrix for

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDown.<b>attribute</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeDescription</b></code>](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDown.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The order in which the drilldown should be generated

#### [<code style={{ fontWeight: 'normal' }}>ClusterDrillDown.<b>displayType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ClusterDrillDownDisplayTypes!</b></code>](/reference/legacy/graphql-v1/enums/cluster-drill-down-display-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicator how to display the current drilldown selection

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IClusterDrillDown</b></code>](/reference/legacy/graphql-v1/interfaces/icluster-drill-down.mdx) <Badge class="badge badge--secondary " text="interface"/>

The interface for the ClusterDrillDown type, this describes the a cluster's drill down cosfiguration.

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## ClusterOption

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cluster-option

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ClusterOption implements IClusterOption {
  id: Int!
  clusterOptionId: Int!
  isRequired: Boolean!
  isHidden: YesNo!
  defaultProduct: Product
  products: [Product!]!
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>clusterOptionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The classID of the cluster that represents this cluster

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>isRequired</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether an option is required or not

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Indicates whether an option is hidden or not

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>defaultProduct</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

The default product that should be selected for this option

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Product!]!</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>ClusterOption.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>ClusterOption.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ClusterOption.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>ClusterOption.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IClusterOption</b></code>](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary " text="interface"/>

Container for a set of options belonging to a configurable cluster

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/>

---

## Cluster

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/cluster

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Cluster implements ICluster, IBaseProduct, IResource {
  id: Int!
  categoryId: Int!
  clusterId: Int!
  attributeValues(
    filter: AttributeFilterInput
  ): AttributeValueResponse!
  category: Category!
  categoryPath: [Category!]!
  crossupsells(
    input: CrossupsellTypesInput
  ): [Crossupsell!]!
  favoriteLists(
    input: FavoriteListsSearchInput
  ): FavoriteListsResponse
  orderlists(
    input: OrderlistSearchInput
  ): OrderlistsResponse!
  products: [Product!]
  options: [ClusterOption!]
  drillDown: [ClusterDrillDown!]
  defaultProduct: Product
  name(
    language: String
  ): [LocalizedString!]!
  description(
    language: String
  ): [LocalizedString!]!
  shortDescription(
    language: String
  ): [LocalizedString!]!
  slug(
    language: String
  ): [LocalizedString!]!
  sku: String!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The classID of this cluster

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>Cluster.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>category</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Category!</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>categoryPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Category!]!</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>crossupsells</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Crossupsell!]!</b></code>](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.crossupsells.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CrossupsellTypesInput</b></code>](/reference/legacy/graphql-v1/inputs/crossupsell-types-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>favoriteLists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>orderlists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistsResponse!</b></code>](/reference/legacy/graphql-v1/objects/orderlists-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.orderlists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Product!]</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Array of selectable main products for this cluster, when the array contains more than one. Only one can be added per cart/order item

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>options</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ClusterOption!]</b></code>](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The configuration options for this cluster

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>drillDown</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ClusterDrillDown!]</b></code>](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The drilldown configuration for this cluster

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>defaultProduct</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Cluster.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Stock keeping unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default language for this product or cluster,
this is the language to fall back too, when there is no translation avaialbe in a specific language.

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>sources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductSource!]!</b></code>](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Path is no longer supported



The catalog path of this product.
Contains a list of ID's of categories with a / as delimiter

#### [<code style={{ fontWeight: 'normal' }}>Cluster.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ICluster</b></code>](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary " text="interface"/>

The interface for the Cluster type

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseProduct</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseProduct Type, where both Products and
clusters derive from

#### [<code style={{ fontWeight: 'normal' }}><b>IResource</b></code>](/reference/legacy/graphql-v1/interfaces/iresource.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Returned By

[`cluster`](/reference/legacy/graphql-v1/queries/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CompaniesResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/companies-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CompaniesResponse {
  items: [Company!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Company!]!</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Company

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>CompaniesResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`companies`](/reference/legacy/graphql-v1/queries/companies.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Company

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/company

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Company {
  companyId: Int!
  addresses(type: AddressType, isDefault: YesNo): [Address!]!
  favoriteLists(input: FavoriteListsBaseSearchInput): FavoriteListsResponse
  orderlist: Orderlist
  id: Int! @deprecated
  name: String!
  taxNumber: String
  cocNumber: String
  notes: String
  hidden: YesNo
  inheritProductList: YesNo
  path: String
  slug: String
  tag: String
  dateCreated: DateTime
  lastModifiedDate: DateTime
  parentUsergroupId: Int!
  usergroup: Usergroup
  contacts(
    input: ContactSearchArguments = { page: 1, offset: 12 }
  ): ContactsResponse
  managers: [IBaseUser!]
  usergroupPath: [Usergroup!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>addresses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Address!]!</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Company.addresses.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

##### [<code style={{ fontWeight: 'normal' }}>Company.addresses.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>favoriteLists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Company.favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsBaseSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>orderlist</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The tax number of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The coc number of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Shows whether this company is hidden and should only be used for background operations.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>inheritProductList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The path in id's to the root of the inheritance tree.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The slug of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The tag of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>parentUsergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>usergroup</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

Parent usergroup of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>contacts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ContactsResponse</b></code>](/reference/legacy/graphql-v1/objects/contacts-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Children contacts of the company.

##### [<code style={{ fontWeight: 'normal' }}>Company.contacts.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ContactSearchArguments</b></code>](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>managers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBaseUser!]</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="interface"/>

Users/ contacts which are account managers of the company.

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>usergroupPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Usergroup!]!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Company.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use companyId instead.



The unique identifier of the company.

</Details>

### Returned By

[`company`](/reference/legacy/graphql-v1/queries/company.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`companyCreate`](/reference/legacy/graphql-v1/mutations/company-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`companyUpdate`](/reference/legacy/graphql-v1/mutations/company-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CompaniesResponse`](/reference/legacy/graphql-v1/objects/companies-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Contact

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/contact

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Contact implements IBaseUser {
  id: Int! @deprecated
  contactId: Int!
  attributes(filter: AttributeFilterInput): [Attribute!]! @deprecated
  attributeValues(filter: AttributeFilterInput): AttributeValueResponse!
  favoriteLists(input: FavoriteListsBaseSearchInput): FavoriteListsResponse
  orderlist: Orderlist
  debtorId: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  phone: String
  mobile: String
  email: String!
  iban: String
  bankAccount: String
  bic: String
  notes: String
  primaryLanguage: String
  expires: DateTime
  externalId: String
  dateOfBirth: DateTime
  mailingList: YesNo
  isLoggedIn: Boolean
  dateCreated: DateTime
  lastModifiedDate: DateTime
  parentCompanyId: Int!
  company: Company
  managedCompanies: [Company!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The unique identifier of the contact.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>Contact.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>favoriteLists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Contact.favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsBaseSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>orderlist</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

The gender of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The first name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The middle name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The last name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The phone number of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The mobile number of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>iban</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The International Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>bankAccount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>bic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Identification Code of the user

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>expires</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expiration date of the contact. After this date expires contact will be disabled.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External ID

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date of birth of the contact.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>isLoggedIn</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>parentCompanyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The company id of parent company.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Company</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>managedCompanies</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Company!]</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Companies managed by the contact.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use contactId instead.



The unique identifier of the user.

#### [<code style={{ fontWeight: 'normal' }}>Contact.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Attribute!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated is favour of attributeValues.
Added pagination to ther query the default offset will be 12 values.
Increasing the offset in a listed view will impact the performance of the api.



Returns an array of legacy Attribute Entities

##### [<code style={{ fontWeight: 'normal' }}>Contact.attributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

### Returned By

[`contact`](/reference/legacy/graphql-v1/queries/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`contactCreate`](/reference/legacy/graphql-v1/mutations/contact-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`contactUpdate`](/reference/legacy/graphql-v1/mutations/contact-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`ContactsResponse`](/reference/legacy/graphql-v1/objects/contacts-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ContactsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/contacts-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ContactsResponse {
  items: [Contact!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Contact!]!</b></code>](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Contact

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>ContactsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`contacts`](/reference/legacy/graphql-v1/queries/contacts.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Crossupsell

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/crossupsell

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Crossupsell {
  productId: Int
  clusterId: Int
  type: CrossupsellTypes!
  subtype: String!
  product: Product @deprecated
  item: IBaseProduct
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cross/Up Sell product identifier

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Cross/Up Sell cluster identifier

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CrossupsellTypes!</b></code>](/reference/legacy/graphql-v1/enums/crossupsell-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Cross/Up Sell type

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>subtype</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Cross/Up Sell subtype

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>item</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseProduct</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary " text="interface"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Crossupsell.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of item



</Details>

### Returned By

[`crossupsells`](/reference/legacy/graphql-v1/queries/crossupsells.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CsvImportResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/csv-import-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CsvImportResponse {
  importedCount: Int!
  errors: [CsvRecordError!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CsvImportResponse.<b>importedCount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CsvImportResponse.<b>errors</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[CsvRecordError!]</b></code>](/reference/legacy/graphql-v1/objects/csv-record-error.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`inventoryCsvImport`](/reference/legacy/graphql-v1/mutations/inventory-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaDocumentCsvImport`](/reference/legacy/graphql-v1/mutations/media-document-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaImageCsvImport`](/reference/legacy/graphql-v1/mutations/media-image-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaVideoCsvImport`](/reference/legacy/graphql-v1/mutations/media-video-csv-import.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## CsvRecordError

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/csv-record-error

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CsvRecordError {
  code: CsvRecordErrorCode!
  messages: [String!]!
  record: JSONObject
  rowNumber: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordError.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CsvRecordErrorCode!</b></code>](/reference/legacy/graphql-v1/enums/csv-record-error-code.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordError.<b>messages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordError.<b>record</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>CsvRecordError.<b>rowNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`CsvImportResponse`](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Customer

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/customer

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Customer implements IBaseUser {
  customerId: Int!
  addresses(type: AddressType, isDefault: YesNo): [Address!]!
  id: Int! @deprecated
  attributes(filter: AttributeFilterInput): [Attribute!]! @deprecated
  attributeValues(filter: AttributeFilterInput): AttributeValueResponse!
  favoriteLists(input: FavoriteListsBaseSearchInput): FavoriteListsResponse
  orderlist: Orderlist
  debtorId: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  phone: String
  mobile: String
  email: String!
  iban: String
  bankAccount: String
  bic: String
  notes: String
  primaryLanguage: String
  expires: DateTime
  externalId: String
  dateOfBirth: DateTime
  mailingList: YesNo
  isLoggedIn: Boolean
  dateCreated: DateTime
  lastModifiedDate: DateTime
  parentUsergroupId: Int!
  usergroup: Usergroup
  usergroupPath: [Usergroup!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the customer.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>addresses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Address!]!</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Customer.addresses.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

##### [<code style={{ fontWeight: 'normal' }}>Customer.addresses.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>Customer.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>favoriteLists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Customer.favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsBaseSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>orderlist</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

The gender of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The first name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The middle name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The last name of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The phone number of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The mobile number of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>iban</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The International Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>bankAccount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>bic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Identification Code of the user

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>expires</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expiration date of the contact. After this date expires contact will be disabled.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External ID

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date of birth of the contact.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>isLoggedIn</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>parentUsergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The usergroup id of parent usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>usergroup</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>usergroupPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Usergroup!]!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use customerId instead.



The unique identifier of the user.

#### [<code style={{ fontWeight: 'normal' }}>Customer.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Attribute!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated is favour of attributeValues.
Added pagination to ther query the default offset will be 12 values.
Increasing the offset in a listed view will impact the performance of the api.



Returns an array of legacy Attribute Entities

##### [<code style={{ fontWeight: 'normal' }}>Customer.attributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

### Returned By

[`customer`](/reference/legacy/graphql-v1/queries/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`customerCreate`](/reference/legacy/graphql-v1/mutations/customer-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`customerUpdate`](/reference/legacy/graphql-v1/mutations/customer-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CustomersResponse`](/reference/legacy/graphql-v1/objects/customers-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## CustomersResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/customers-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type CustomersResponse {
  items: [Customer!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Customer!]!</b></code>](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Customer

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>CustomersResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`customers`](/reference/legacy/graphql-v1/queries/customers.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## DeleteMediaAttachmentResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/delete-media-attachment-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Response confirming successful deletion of a private attachment file

```graphql
type DeleteMediaAttachmentResponse {
  mediaId: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DeleteMediaAttachmentResponse.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the successfully deleted attachment.

    This ID can be used to confirm which private attachment was removed from the system. The attachment file and all its associated metadata are permanently deleted and cannot be recovered.

### Returned By

[`mediaAttachmentDelete`](/reference/legacy/graphql-v1/mutations/media-attachment-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## DeleteMediaDocumentResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/delete-media-document-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Response confirming successful deletion of a document media item

```graphql
type DeleteMediaDocumentResponse {
  mediaId: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DeleteMediaDocumentResponse.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the successfully deleted document.

    This ID can be used to confirm which document was removed from the system. The document file and all its associated metadata are permanently deleted and cannot be recovered.

### Returned By

[`mediaDocumentDelete`](/reference/legacy/graphql-v1/mutations/media-document-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## DeleteMediaImageResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/delete-media-image-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Response confirming successful deletion of an image media item

```graphql
type DeleteMediaImageResponse {
  mediaId: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DeleteMediaImageResponse.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the successfully deleted image.

    This ID can be used to confirm which image was removed from the system. The image and all its associated files are permanently deleted and cannot be recovered.

### Returned By

[`mediaImageDelete`](/reference/legacy/graphql-v1/mutations/media-image-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## DeleteMediaVideoResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/delete-media-video-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Response confirming successful deletion of a video media item

```graphql
type DeleteMediaVideoResponse {
  mediaId: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>DeleteMediaVideoResponse.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the successfully deleted video.

    This ID can be used to confirm which video was removed from the system. The video and all its associated metadata are permanently deleted and cannot be recovered.

### Returned By

[`mediaVideoDelete`](/reference/legacy/graphql-v1/mutations/media-video-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## Discount

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/discount

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Discount {
  discountId: String!
  formula: String!
  type: String!
  quantity: Int!
  value: Float
  validFrom: DateTime
  validTo: DateTime
  hops: Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>discountId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>formula</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>validFrom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>validTo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Discount.<b>hops</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`userDiscounts`](/reference/legacy/graphql-v1/queries/user-discounts.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`ProductPrice`](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ExternalAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/external-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ExternalAddress {
  id: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  fax: String
  code: String
  notes: String
  icp: YesNo
  url: String
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Address gender

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address street

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number extension

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fixed phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Mobile phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email that applies to this address [valid email format needed]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>fax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fax number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address company domain url

#### [<code style={{ fontWeight: 'normal' }}>ExternalAddress.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address friendly descriptive name

### Returned By

[`externalAddress`](/reference/legacy/graphql-v1/queries/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`externalAddressCreate`](/reference/legacy/graphql-v1/mutations/external-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`externalAddressUpdate`](/reference/legacy/graphql-v1/mutations/external-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/favorite-list

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type FavoriteList {
  id: ID!
  name: String!
  companyId: Int
  contactId: Int
  customerId: Int
  isDefault: Boolean!
  slug: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  products(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    path: String
    categoryId: Int
    sku: [String!]
    getDescendants: Boolean = true
  ): ProductsResponse
  clusters(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    path: String
    categoryId: Int
    sku: [String!]
    getDescendants: Boolean = true
  ): ProductsResponse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List unique identifier

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List name

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List company ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List contact ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Favorite List customer ID

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default Favorite List

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List slug

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List date created

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>updatedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Favorite List date modified

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductsResponse</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique category identifier

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.products.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

#### [<code style={{ fontWeight: 'normal' }}>FavoriteList.<b>clusters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductsResponse</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique category identifier

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

##### [<code style={{ fontWeight: 'normal' }}>FavoriteList.clusters.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

### Returned By

[`favoriteList`](/reference/legacy/graphql-v1/queries/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`favoriteListAddItems`](/reference/legacy/graphql-v1/mutations/favorite-list-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListClearItems`](/reference/legacy/graphql-v1/mutations/favorite-list-clear-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListCreate`](/reference/legacy/graphql-v1/mutations/favorite-list-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListRemoveItems`](/reference/legacy/graphql-v1/mutations/favorite-list-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListUpdate`](/reference/legacy/graphql-v1/mutations/favorite-list-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`FavoriteListsResponse`](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## FavoriteListsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/favorite-lists-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type FavoriteListsResponse {
  items: [FavoriteList!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[FavoriteList!]!</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type FavoriteList

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>FavoriteListsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`favoriteLists`](/reference/legacy/graphql-v1/queries/favorite-lists.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Firebase

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/firebase

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Firebase {
  identities: JSONObject
  sign_in_provider: String!
  sign_in_second_factor: String
  second_factor_identifier: String
  tenant: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Firebase.<b>identities</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Firebase.<b>sign_in_provider</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Firebase.<b>sign_in_second_factor</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Firebase.<b>second_factor_identifier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Firebase.<b>tenant</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`VerifyToken`](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## GCIPMetadata

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/gcipmetadata

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type GCIPMetadata {
  lastSignInTime: String
  creationTime: String
  lastRefreshTime: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>GCIPMetadata.<b>lastSignInTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPMetadata.<b>creationTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPMetadata.<b>lastRefreshTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`GCIPUser`](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## GCIPProviderData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/gcipprovider-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type GCIPProviderData {
  uid: String
  providerId: String
  displayName: String
  photoUrl: String
  federatedId: String
  email: String
  rawId: String
  screenName: String
  phoneNumber: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>providerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>displayName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>photoUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>federatedId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>rawId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>screenName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPProviderData.<b>phoneNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`GCIPUser`](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## GCIPUser

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/gcipuser

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type GCIPUser {
  uid: String!
  email: String
  emailVerified: Boolean
  displayName: String
  photoUrl: String
  phoneNumber: String
  disabled: Boolean
  isAnonymous: Boolean
  metadata: GCIPMetadata
  tokensValidAfterTime: String
  tenantId: String
  providerData: [GCIPProviderData!]!
  passwordHash: String
  passwordSalt: String
  authDomain: String
  lastLoginAt: DateTime
  createdAt: DateTime
  accessToken: String!
  refreshToken: String!
  expirationTime: DateTime
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>emailVerified</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>displayName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>photoUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>phoneNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>disabled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>isAnonymous</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>metadata</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>GCIPMetadata</b></code>](/reference/legacy/graphql-v1/objects/gcipmetadata.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>tokensValidAfterTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>tenantId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>providerData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[GCIPProviderData!]!</b></code>](/reference/legacy/graphql-v1/objects/gcipprovider-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>passwordHash</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>passwordSalt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>authDomain</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>lastLoginAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>accessToken</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>refreshToken</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>GCIPUser.<b>expirationTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`authentication`](/reference/legacy/graphql-v1/queries/authentication.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Login`](/reference/legacy/graphql-v1/objects/login.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ImageVariant

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/image-variant

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

A transformed version of an image with specific modifications applied

```graphql
type ImageVariant {
  name: String!
  language: String!
  url: String!
  mimeType: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ImageVariant.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Human-readable name for the image variant.

    Typically describes the transformation applied or the intended use case (e.g., 'thumbnail', 'hero-banner', 'mobile-optimized').

#### [<code style={{ fontWeight: 'normal' }}>ImageVariant.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code associated with this image variant.

    Indicates the language context for localized image content or text overlays. Uses standard language codes like 'EN', 'DE', 'FR'.

#### [<code style={{ fontWeight: 'normal' }}>ImageVariant.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Direct URL to access the transformed image.

    Fully qualified URL that can be used to display or download the transformed image. The URL includes all applied transformations and optimizations.

#### [<code style={{ fontWeight: 'normal' }}>ImageVariant.<b>mimeType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MIME type of the transformed image.

    Indicates the file format of the transformed image (e.g., 'image/jpeg', 'image/webp', 'image/png'). May differ from the original image format based on transformations applied.

### Member Of

[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## InventoryDeleteResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/inventory-delete-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type InventoryDeleteResponse {
  messages: [String!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>InventoryDeleteResponse.<b>messages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Error messages

### Returned By

[`inventoryDelete`](/reference/legacy/graphql-v1/mutations/inventory-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## InventoryResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/inventory-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type InventoryResponse {
  id: ID!
  productId: Int!
  quantity: Int!
  costPrice: Float!
  supplier: String!
  supplierCode: String!
  sku: String!
  dateModified: DateTime
  warehouseId: Int!
  location: String!
  nextDeliveryDate: DateTime!
  notes: String!
  messages: [String!]!
  total: Int!
  warehouse: Warehouse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory primary identifier

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory product identifier

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory quantity

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory cost price

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory supplier

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory supplier code

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory sku

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>dateModified</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory last modified date

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory warehouse identifier

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>location</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory location

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>nextDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory estimated next delivery date

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory note

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>messages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Error messages

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total

#### [<code style={{ fontWeight: 'normal' }}>InventoryResponse.<b>warehouse</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`inventory`](/reference/legacy/graphql-v1/queries/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`inventoryCreate`](/reference/legacy/graphql-v1/mutations/inventory-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`inventoryUpdate`](/reference/legacy/graphql-v1/mutations/inventory-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/inventory

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Inventory {
  id: ID!
  productId: Int!
  quantity: Int!
  costPrice: Float!
  supplier: String!
  supplierCode: String!
  sku: String!
  dateModified: DateTime
  warehouseId: Int!
  location: String!
  nextDeliveryDate: DateTime!
  notes: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory product identifier

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory quantity

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory cost price

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory supplier

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory supplier code

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory sku

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>dateModified</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory last modified date

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>warehouseId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory warehouse identifier

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>location</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory location

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>nextDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory estimated next delivery date

#### [<code style={{ fontWeight: 'normal' }}>Inventory.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory note

### Member Of

[`ProductInventory`](/reference/legacy/graphql-v1/objects/product-inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedAttachment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-attachment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Language-specific private attachment file with metadata and access information

```graphql
type LocalizedAttachment {
  language: String!
  originalUrl: String!
  mimeType: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedAttachment.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for this attachment variant.

    Indicates the language context or locale for which this attachment is intended. Uses standard language codes like 'EN', 'DE', 'FR'.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedAttachment.<b>originalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Secure URL to the original attachment file.

    Provides access to the private attachment file with appropriate security measures. Access is restricted based on user permissions and ownership rules.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedAttachment.<b>mimeType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MIME type of the attachment file.

    Indicates the file format (e.g., 'application/pdf', 'application/zip', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'). Used for proper file handling and security validation.

### Member Of

[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedDocument

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-document

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Language-specific document file with metadata and storage information

```graphql
type LocalizedDocument {
  language: String!
  originalUrl: String!
  mimeType: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedDocument.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for this document variant.

    Indicates the language context or locale for which this document is intended. Uses standard language codes like 'EN', 'DE', 'FR'.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedDocument.<b>originalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Direct URL to the original, unmodified document file.

    Provides access to the source document as originally uploaded, without any modifications. Used for downloading and viewing the document in its original format.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedDocument.<b>mimeType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MIME type of the document file.

    Indicates the document format (e.g., 'application/pdf', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'). Determines how the document should be processed and displayed.

### Member Of

[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedImage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-image

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Language-specific image file with metadata and storage information

```graphql
type LocalizedImage {
  language: String!
  originalUrl: String!
  mimeType: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedImage.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for this image variant.

    Indicates the language context or locale for which this image is intended. Uses standard language codes like 'EN', 'DE', 'FR'.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedImage.<b>originalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Direct URL to the original, unmodified image file.

    Provides access to the source image as originally uploaded, without any transformations or optimizations applied. Used as the base for generating variants.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedImage.<b>mimeType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

MIME type of the original image file.

    Indicates the file format of the stored image (e.g., 'image/jpeg', 'image/png', 'image/webp'). Determines how the image should be processed and displayed.

### Member Of

[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedStringArray

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-string-array

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type LocalizedStringArray {
  language: String!
  values: [String!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringArray.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>LocalizedStringArray.<b>values</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedString

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-string

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

A String representation of a type Field that is suitable for Localization

```graphql
type LocalizedString {
  language: String!
  value: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedString.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>LocalizedString.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescription`](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleActionField`](/reference/legacy/graphql-v1/objects/business-rule-action-field.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableCell`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBaseProduct`](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterOption`](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PayMethod`](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePart`](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetItem`](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## LocalizedVideo

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/localized-video

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Language-specific video file with metadata and location information

```graphql
type LocalizedVideo {
  language: String!
  uri: String!
  mimeType: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>LocalizedVideo.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Language code for this video variant.

    Indicates the language context or locale for which this video is intended. Uses standard language codes like 'EN', 'DE', 'FR'.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedVideo.<b>uri</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

URI or URL pointing to the video content.

    Can be a direct link to a video file, or a URL from supported video platforms like YouTube or Vimeo. The URI must be accessible for playback.

#### [<code style={{ fontWeight: 'normal' }}>LocalizedVideo.<b>mimeType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

MIME type of the video file.

    Indicates the video format and encoding (e.g., 'video/mp4', 'video/webm'). Used by browsers and players to determine how to handle the video content.

### Member Of

[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Login

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/login

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Login {
  providerId: String
  operationType: String
  session: GCIPUser
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Login.<b>providerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Login.<b>operationType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Login.<b>session</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>GCIPUser</b></code>](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`authenticationCreate`](/reference/legacy/graphql-v1/mutations/authentication-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`login`](/reference/legacy/graphql-v1/mutations/login.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`startSession`](/reference/legacy/graphql-v1/mutations/start-session.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## Logout

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/logout

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Logout {
  todo: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Logout.<b>todo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`logout`](/reference/legacy/graphql-v1/deprecated/mutations/logout.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## MediaAttachment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/media-attachment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Private attachment file with restricted access and ownership controls

```graphql
type MediaAttachment {
  id: ID!
  sparePartsMachineId: ID
  alt: [LocalizedString!]!
  description: [LocalizedString!]!
  tags: [LocalizedStringArray!]!
  type: String
  createdAt: DateTime
  lastModifiedAt: DateTime
  priority: Int
  attachments: [LocalizedAttachment!]
  orderId: Int
  companyId: Int
  customerId: Int
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Globally unique identifier for the media item.

    Used to reference and retrieve the specific media item across all operations. This ID is immutable and unique across the entire media system.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine for maintenance and service documentation

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Essential for web accessibility compliance and search engine optimization.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for content management, search indexing, and user information display.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Searchable tags for categorizing and organizing media content.

    Keywords that help classify and discover media items. Used for search functionality, content filtering, and organizational purposes.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Type classification of the media item.

    Indicates whether this is an image, video, document, or attachment. Used for processing, display, and filtering logic.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was originally created.

    Recorded in ISO 8601 format with timezone information. Used for sorting, filtering, and audit purposes.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was last modified.

    Updated whenever the media metadata or content is changed. Recorded in ISO 8601 format with timezone information.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries, carousels, and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedAttachment!]</b></code>](/reference/legacy/graphql-v1/objects/localized-attachment.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Collection of private attachment files in different languages and formats.

    Contains confidential or sensitive files that are restricted to specific users or organizations. Each attachment can have multiple language variants and format versions.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the attachment with a specific order.

    Links the attachment to order-related documentation such as invoices, contracts, or delivery notes. Cannot be used simultaneously with sparePartsMachineId as attachments are associated with either orders or machines.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the attachment with a specific company owner.

    Indicates that the attachment belongs to and is accessible by the specified company. Cannot be used simultaneously with customerId as attachments have a single owner type.

#### [<code style={{ fontWeight: 'normal' }}>MediaAttachment.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the attachment with a specific customer owner.

    Indicates that the attachment belongs to and is accessible by the specified customer. Cannot be used simultaneously with companyId as attachments have a single owner type.

### Returned By

[`mediaAttachmentCreate`](/reference/legacy/graphql-v1/mutations/media-attachment-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaAttachmentUpdate`](/reference/legacy/graphql-v1/mutations/media-attachment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaAttachmentResponse`](/reference/legacy/graphql-v1/objects/paginated-media-attachment-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## MediaDocument

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/media-document

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Document media item with file access and metadata management capabilities

```graphql
type MediaDocument {
  id: ID!
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  tags(language: String): [LocalizedStringArray!]!
  type: String
  createdAt: DateTime
  lastModifiedAt: DateTime
  priority: Int
  documents: [LocalizedDocument!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Globally unique identifier for the media item.

    Used to reference and retrieve the specific media item across all operations. This ID is immutable and unique across the entire media system.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product for product catalogs and displays

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster for organizational grouping

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category for categorization and filtering

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine for maintenance and service documentation

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Essential for web accessibility compliance and search engine optimization.

##### [<code style={{ fontWeight: 'normal' }}>MediaDocument.alt.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for content management, search indexing, and user information display.

##### [<code style={{ fontWeight: 'normal' }}>MediaDocument.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Searchable tags for categorizing and organizing media content.

    Keywords that help classify and discover media items. Used for search functionality, content filtering, and organizational purposes.

##### [<code style={{ fontWeight: 'normal' }}>MediaDocument.tags.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Type classification of the media item.

    Indicates whether this is an image, video, document, or attachment. Used for processing, display, and filtering logic.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was originally created.

    Recorded in ISO 8601 format with timezone information. Used for sorting, filtering, and audit purposes.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was last modified.

    Updated whenever the media metadata or content is changed. Recorded in ISO 8601 format with timezone information.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries, carousels, and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaDocument.<b>documents</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedDocument!]</b></code>](/reference/legacy/graphql-v1/objects/localized-document.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Collection of document files in different languages and formats.

    Contains the actual document files with their metadata, file sizes, and storage locations. Each document can have multiple language variants and format versions such as PDF, DOCX, or XLSX.

### Returned By

[`mediaDocument`](/reference/legacy/graphql-v1/deprecated/queries/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`mediaDocumentCreate`](/reference/legacy/graphql-v1/mutations/media-document-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaDocumentUpdate`](/reference/legacy/graphql-v1/mutations/media-document-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaDocumentResponse`](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## MediaImage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/media-image

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type MediaImage {
  id: ID!
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  tags(language: String): [LocalizedStringArray!]!
  type: String
  createdAt: DateTime
  lastModifiedAt: DateTime
  priority: Int
  images: [LocalizedImage!]
  imageVariants(input: TransformationsInput!): [ImageVariant!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Globally unique identifier for the media item.

    Used to reference and retrieve the specific media item across all operations. This ID is immutable and unique across the entire media system.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product for product catalogs and displays

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster for organizational grouping

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category for categorization and filtering

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine for maintenance and service documentation

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Essential for web accessibility compliance and search engine optimization.

##### [<code style={{ fontWeight: 'normal' }}>MediaImage.alt.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for content management, search indexing, and user information display.

##### [<code style={{ fontWeight: 'normal' }}>MediaImage.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Searchable tags for categorizing and organizing media content.

    Keywords that help classify and discover media items. Used for search functionality, content filtering, and organizational purposes.

##### [<code style={{ fontWeight: 'normal' }}>MediaImage.tags.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Type classification of the media item.

    Indicates whether this is an image, video, document, or attachment. Used for processing, display, and filtering logic.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was originally created.

    Recorded in ISO 8601 format with timezone information. Used for sorting, filtering, and audit purposes.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was last modified.

    Updated whenever the media metadata or content is changed. Recorded in ISO 8601 format with timezone information.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries, carousels, and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>images</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedImage!]</b></code>](/reference/legacy/graphql-v1/objects/localized-image.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Collection of image files in different languages and formats.

    Contains the actual image files with their metadata, dimensions, file sizes, and storage locations. Each image can have multiple language variants and format versions.

#### [<code style={{ fontWeight: 'normal' }}>MediaImage.<b>imageVariants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ImageVariant!]</b></code>](/reference/legacy/graphql-v1/objects/image-variant.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of image variant objects

##### [<code style={{ fontWeight: 'normal' }}>MediaImage.imageVariants.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransformationsInput!</b></code>](/reference/legacy/graphql-v1/inputs/transformations-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Transformation specifications to apply to the image.

      Each transformation in the array is applied sequentially. Common transformations include resizing, format conversion, quality optimization, and visual effects.

### Returned By

[`mediaImage`](/reference/legacy/graphql-v1/deprecated/queries/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`mediaImageCreate`](/reference/legacy/graphql-v1/mutations/media-image-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaImageUpdate`](/reference/legacy/graphql-v1/mutations/media-image-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaImageResponse`](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## MediaVideo

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/media-video

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type MediaVideo {
  id: ID!
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]!
  tags(language: String): [LocalizedStringArray!]!
  type: String
  createdAt: DateTime
  lastModifiedAt: DateTime
  priority: Int
  videos: [LocalizedVideo!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Globally unique identifier for the media item.

    Used to reference and retrieve the specific media item across all operations. This ID is immutable and unique across the entire media system.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product for product catalogs and displays

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific cluster for organizational grouping

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific product category for categorization and filtering

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>sparePartsMachineId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Associates the media item with a specific spare parts machine for maintenance and service documentation

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>alt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Alternative text descriptions for accessibility and SEO purposes.

    Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Essential for web accessibility compliance and search engine optimization.

##### [<code style={{ fontWeight: 'normal' }}>MediaVideo.alt.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Detailed descriptions of the media content.

    Provides comprehensive information about what the media shows or contains. Used for content management, search indexing, and user information display.

##### [<code style={{ fontWeight: 'normal' }}>MediaVideo.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>tags</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedStringArray!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Searchable tags for categorizing and organizing media content.

    Keywords that help classify and discover media items. Used for search functionality, content filtering, and organizational purposes.

##### [<code style={{ fontWeight: 'normal' }}>MediaVideo.tags.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Type classification of the media item.

    Indicates whether this is an image, video, document, or attachment. Used for processing, display, and filtering logic.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was originally created.

    Recorded in ISO 8601 format with timezone information. Used for sorting, filtering, and audit purposes.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the media item was last modified.

    Updated whenever the media metadata or content is changed. Recorded in ISO 8601 format with timezone information.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Display order priority for the media item.

    Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries, carousels, and listings.

#### [<code style={{ fontWeight: 'normal' }}>MediaVideo.<b>videos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedVideo!]</b></code>](/reference/legacy/graphql-v1/objects/localized-video.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Collection of video files in different languages and formats.

    Contains the actual video files with their metadata, hosting information, and playback details. Each video can have multiple language variants and may be hosted on different platforms.

### Returned By

[`mediaVideo`](/reference/legacy/graphql-v1/deprecated/queries/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`mediaVideoCreate`](/reference/legacy/graphql-v1/mutations/media-video-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`mediaVideoUpdate`](/reference/legacy/graphql-v1/mutations/media-video-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaVideoResponse`](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Media

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/media

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Unified media access point providing single items and paginated collections for all media types

```graphql
type Media {
  image(mediaId: String!): MediaImage
  images(
    search: MediaImageSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaImageResponse
  video(mediaId: String!): MediaVideo
  videos(
    search: MediaVideoSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaVideoResponse
  document(mediaId: String!): MediaDocument
  documents(
    search: MediaDocumentSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaDocumentResponse
  attachment(id: String!): MediaAttachment!
  attachments(
    input: MediaAttachmentSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaAttachmentResponse!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>image</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImage</b></code>](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary " text="object"/>

Single image media item.

    Provides access to a specific image with its metadata, transformations, and localized variants. Used for retrieving individual images by ID.

##### [<code style={{ fontWeight: 'normal' }}>Media.image.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the image to retrieve.

      Must be a valid media ID representing an existing image in the media storage system.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>images</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated collection of image media items.

    Returns a searchable and filterable list of images with pagination support. Includes metadata for navigation and result counts.

##### [<code style={{ fontWeight: 'normal' }}>Media.images.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering images.

      If not provided, returns all accessible images with default pagination settings. Supports filtering by metadata, dimensions, file types, and upload dates.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>video</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideo</b></code>](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary " text="object"/>

Single video media item.

    Provides access to a specific video with its metadata, hosting information, and localized variants. Used for retrieving individual videos by ID.

##### [<code style={{ fontWeight: 'normal' }}>Media.video.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the video to retrieve.

      Must be a valid media ID representing an existing video in the media storage system.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>videos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated collection of video media items.

    Returns a searchable and filterable list of videos with pagination support. Includes metadata for navigation and result counts.

##### [<code style={{ fontWeight: 'normal' }}>Media.videos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering videos.

      If not provided, returns all accessible videos with default pagination settings. Supports filtering by metadata, duration, resolution, file types, and upload dates.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>document</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocument</b></code>](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary " text="object"/>

Single document media item.

    Provides access to a specific document with its metadata, file information, and localized variants. Used for retrieving individual documents by ID.

##### [<code style={{ fontWeight: 'normal' }}>Media.document.<b>mediaId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the document to retrieve.

      Must be a valid media ID representing an existing document in the media storage system.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>documents</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated collection of document media items.

    Returns a searchable and filterable list of documents with pagination support. Includes metadata for navigation and result counts.

##### [<code style={{ fontWeight: 'normal' }}>Media.documents.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering documents.

      If not provided, returns all accessible documents with default pagination settings. Supports filtering by metadata, file types, sizes, and upload dates.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>attachment</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaAttachment!</b></code>](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Retrieve a specific attachment by its identifier.

    Returns detailed information about an attachment including metadata, storage location, file information, and association details. Used for attachment display and management operations.

##### [<code style={{ fontWeight: 'normal' }}>Media.attachment.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the attachment to retrieve.

      Must be a valid attachment ID representing an existing attachment in the media storage system.

#### [<code style={{ fontWeight: 'normal' }}>Media.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaAttachmentResponse!</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-attachment-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Search and retrieve attachments with comprehensive filtering and pagination.

    Provides flexible search capabilities across attachment metadata including names, file types, associations, and upload dates. Results are paginated and filtered based on user permissions for secure access control.

##### [<code style={{ fontWeight: 'normal' }}>Media.attachments.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaAttachmentSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-attachment-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering attachments.

      If not provided, returns all accessible attachments with default pagination settings. Supports filtering by metadata, file types, associations, and upload dates. Access is controlled based on user permissions.

### Returned By

[`media`](/reference/legacy/graphql-v1/queries/media.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## OrderItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderItem {
  id: Int!
  orderId: Int!
  uuid: String!
  class: OrderItemClass!
  productId: Int
  parentOrderItemId: Int
  quantity: Int!
  sku: String!
  notes: String
  name: String
  supplier: String
  supplierCode: String
  manufacturer: String
  manufacturerCode: String
  eanCode: String
  originalPrice: Float
  price: Float!
  priceTotal: Float!
  priceNet: Float
  priceTotalNet: Float
  customerPrice: Float
  costPrice: Float
  discount: Float
  tax: Float
  taxPercentage: Int!
  taxCode: Taxcode!
  isBonus: YesNo!
  minumumQuantity: Int @deprecated
  minimumQuantity: Int
  unit: Int
  package: String
  packageUnit: String
  packageUnitQuantity: String
  purchaseUnit: Int
  purchaseMinimumQuantity: Int
  requestDate: DateTime
  product: Product
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The autoincerment ID for the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the Order the OrderItem belongs to

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>uuid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The UUID for the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderItemClass!</b></code>](/reference/legacy/graphql-v1/enums/order-item-class.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The class of the orderItem. Either product, incentive, surcharge, postage, payment

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The productId of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>parentOrderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The ID of the parent OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The SKU of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Remarks by the customer for the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The name of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplier of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The supplierCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The manufacturerCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The eanCode of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The original price of the OrderItem, before applying any discounts

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The calculated price per unit excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>priceTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of the OrderItem excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated price per unit including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>priceTotalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total price of the OrderItem including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The calculated customerPrice of the OrderItem at the time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cost price of the OrderItem at the time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The discount of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The total tax of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>isBonus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is the OrderItem a bonusItem?

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The minimum quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>packageUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>packageUnitQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The package unit quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>purchaseUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The purchase unit of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>purchaseMinimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The purchase minimum quantity of the product of the OrderItem

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested delivery date for this orderline

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>OrderItem.<b>minumumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Use `minimumQuantity` instead



The minimum quantity of the product of the OrderItem

</Details>

### Returned By

[`orderItemCreate`](/reference/legacy/graphql-v1/mutations/order-item-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderItemUpdate`](/reference/legacy/graphql-v1/mutations/order-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderMedia

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-media

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderMedia {
  attachments(
    input: ObjectMediaSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaAttachmentResponse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderMedia.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaAttachmentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-attachment-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Media attachments

##### [<code style={{ fontWeight: 'normal' }}>OrderMedia.attachments.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ObjectMediaSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Order media attachments search options

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderPaymentData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-payment-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderPaymentData {
  net: Float!
  gross: Float!
  tax: Float!
  taxPercentage: Float
  method: String!
  status: String
  statusDate: DateTime
  accountingId: String
  overruled: YesNo
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The transaction cost excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax on the transaction costs

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The paymethod for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The transaction status

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>statusDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last time the transaction status was changed

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The accountingId that belongs to this order

#### [<code style={{ fontWeight: 'normal' }}>OrderPaymentData.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the transaction costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderPostageData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-postage-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderPostageData {
  method: String!
  taxPercentage: Float!
  requestDate: DateTime
  gross: Float!
  net: Float!
  tax: Float!
  partialDeliveryAllowed: YesNo
  pickUpLocationId: Int
  carrier: String
  overruled: YesNo
  warehouse: Warehouse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The chosen shipping method

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for the Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shipping costs including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax on the shipping costs

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Is partial delivery allowed for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

ID of the pick up location when the Order's shipping method is PICKUP

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Whether the shipping costs for this order are overruled, if N, the shipping costs will be recalculated on every mutation

#### [<code style={{ fontWeight: 'normal' }}>OrderPostageData.<b>warehouse</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderResponse {
  items: [Order!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Order!]!</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Order

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>OrderResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`orders`](/reference/legacy/graphql-v1/queries/orders.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderTotalTaxPercentage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-total-tax-percentage

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderTotalTaxPercentage {
  percentage: Int!
  total: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalTaxPercentage.<b>percentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage

#### [<code style={{ fontWeight: 'normal' }}>OrderTotalTaxPercentage.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total for the tax percentage

### Member Of

[`OrderTotals`](/reference/legacy/graphql-v1/objects/order-totals.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderTotals

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order-totals

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderTotals {
  orderId: Int!
  gross: Float!
  net: Float!
  tax: Float!
  discountType: OrderDiscountType!
  discountValue: Float!
  taxPercentages: [OrderTotalTaxPercentage!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The orderId of this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order excluding tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total of this Order including tax

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total amount of tax for this Order

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>discountType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderDiscountType!</b></code>](/reference/legacy/graphql-v1/enums/order-discount-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of global discount

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>discountValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The discount value, can be absolute or a percentage depending on the discountType

#### [<code style={{ fontWeight: 'normal' }}>OrderTotals.<b>taxPercentages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderTotalTaxPercentage!]!</b></code>](/reference/legacy/graphql-v1/objects/order-total-tax-percentage.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The totals per tax percentage

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Order

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/order

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Order {
  id: Int!
  addresses(type: AddressType): [Address!]!
  media: OrderMedia
  userId: Int!
  accountManagerId: Int
  accountingId: String @deprecated
  pickupStoreId: Int @deprecated
  cartId: String
  siteId: Int @deprecated
  channelId: Int
  shopId: Int!
  uuid: String!
  externalId: String
  debtorId: String
  status: String!
  type: OrderType!
  source: String
  email: String!
  emailDate: DateTime
  remarks: String
  reference: String
  extra3: String
  extra4: String
  currency: String!
  currencyRatio: Float!
  language: String!
  date: DateTime!
  statusDate: DateTime
  postageData: OrderPostageData!
  paymentData: OrderPaymentData!
  total: OrderTotals!
  items: [OrderItem!]!
  shipments: [Shipment!]
  invoiceUserId: Int
  validUntil: DateTime
  companyId: Int
  lastModifiedAt: DateTime
  originalOrderId: Int
  exportedAt: DateTime
  exportStatus: OrderExportStatus
  exportMessage: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The auto-incremental id for this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>addresses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Address!]!</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Order.addresses.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>media</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderMedia</b></code>](/reference/legacy/graphql-v1/objects/order-media.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The userId of the user that placed this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>accountManagerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the Owner/Account Manager that will handle this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The cartId of the cart that this order is created from.

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The channel identifier of the webshop this order originated from

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the shop the Order belongs to

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>uuid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External identifier for this order from an external source like an ERP system

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The debtorId of the Customer or Company that placed this Order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The processing status for this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderType!</b></code>](/reference/legacy/graphql-v1/enums/order-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The source this order originates from

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email address for transactional emails

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>emailDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date the last transactional email was sent for this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>remarks</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Remarks added by the customer about this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Reference added by the customer about this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra3: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

extra4: Open text field to add meta data on an Order.
The field will not be visible to Propeller admins, but can be used to be displayed on front-ends or be used in integrations.

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The currency used to place this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>currencyRatio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The currency's exchange rate at the time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected language on the webshop at the time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The date and time the order was placed

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>statusDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time the status of the order was last changed

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPostageData!</b></code>](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The postage data of the order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderPaymentData!</b></code>](/reference/legacy/graphql-v1/objects/order-payment-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The payment data of the order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderTotals!</b></code>](/reference/legacy/graphql-v1/objects/order-totals.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The totals of the order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[OrderItem!]!</b></code>](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

The items included in the order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>shipments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Shipment!]</b></code>](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Shipments for this Order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>invoiceUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the User, contact or Customer that should receive the invoice for this Order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>validUntil</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time until the order is valid

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The companyId of the company that placed this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time the order was last modified

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>originalOrderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Original order id

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>exportedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date and time the order was exported

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>exportStatus</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderExportStatus</b></code>](/reference/legacy/graphql-v1/enums/order-export-status.mdx) <Badge class="badge badge--secondary " text="enum"/>

Order export status of this order

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>exportMessage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Order export message

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favour of paymentData.accountingId



The accounting id

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>pickupStoreId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favour of postageData.pickUpLocationId



The userId of the store that this order can be picked up in case of the pickup shippingMethod is chosen

#### [<code style={{ fontWeight: 'normal' }}>Order.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of channelId



The siteId of the webshop this order originated from

</Details>

### Returned By

[`order`](/reference/legacy/graphql-v1/queries/order.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderCreate`](/reference/legacy/graphql-v1/mutations/order-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderSetStatus`](/reference/legacy/graphql-v1/mutations/order-set-status.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderUpdate`](/reference/legacy/graphql-v1/mutations/order-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`CartProcessResponse`](/reference/legacy/graphql-v1/objects/cart-process-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderResponse`](/reference/legacy/graphql-v1/objects/order-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/orderlist

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Orderlist {
  id: Int!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  descriptions: [LocalizedString!]!
  type: OrderlistType!
  products(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    path: String
    categoryId: Int
    sku: [String!]
    getDescendants: Boolean = true
  ): ProductsResponse
  clusters(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
    path: String
    categoryId: Int
    sku: [String!]
    getDescendants: Boolean = true
  ): ProductsResponse
  users: [IBaseUser!]
  companies: [Company!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Orderlist primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Orderlist creation date

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Orderlist last modified date

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistType!</b></code>](/reference/legacy/graphql-v1/enums/orderlist-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Orderlist type

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>products</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductsResponse</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique category identifier

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.products.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>clusters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductsResponse</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique category identifier

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

##### [<code style={{ fontWeight: 'normal' }}>Orderlist.clusters.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>users</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBaseUser!]</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="interface"/>

#### [<code style={{ fontWeight: 'normal' }}>Orderlist.<b>companies</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Company!]</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`orderlist`](/reference/legacy/graphql-v1/queries/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderlistAddItems`](/reference/legacy/graphql-v1/mutations/orderlist-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistAssignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-assign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistAssignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-assign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistCreate`](/reference/legacy/graphql-v1/mutations/orderlist-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistRemoveItems`](/reference/legacy/graphql-v1/mutations/orderlist-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUnassignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUnassignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUpdate`](/reference/legacy/graphql-v1/mutations/orderlist-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderlistsResponse`](/reference/legacy/graphql-v1/objects/orderlists-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## OrderlistsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/orderlists-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type OrderlistsResponse {
  items: [Orderlist!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Orderlist!]!</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Orderlist

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>OrderlistsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`orderlists`](/reference/legacy/graphql-v1/queries/orderlists.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PaginatedMediaAttachmentResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/paginated-media-attachment-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing private attachment files with navigation metadata

```graphql
type PaginatedMediaAttachmentResponse {
  items: [MediaAttachment!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaAttachment!]!</b></code>](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of items returned for the current page.

      Contains the actual data items matching the search criteria, limited by the pagination settings. The array will be empty if no items match the search criteria.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items matching the search criteria.

      Represents the complete count of items that match the search filters, regardless of pagination. Used to calculate total pages and display result counts.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items displayed per page.

      Controls how many items are returned in each page of results. Used for pagination calculations and determining page boundaries.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number being displayed.

      Indicates which page of results is currently being shown. Pages start at 1 and increment based on the offset size.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of pages available.

      Calculated based on the total items found divided by the items per page. Used for pagination navigation and determining if there are more pages available.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Starting position number for items on the current page.

      Indicates the position of the first item displayed on this page within the complete result set. Useful for displaying "Showing X-Y of Z results" information.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaAttachmentResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Ending position number for items on the current page.

      Indicates the position of the last item displayed on this page within the complete result set. Will not exceed the total number of items found.

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderMedia`](/reference/legacy/graphql-v1/objects/order-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineMedia`](/reference/legacy/graphql-v1/objects/spare-parts-machine-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PaginatedMediaDocumentResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/paginated-media-document-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing document media items with navigation metadata

```graphql
type PaginatedMediaDocumentResponse {
  items: [MediaDocument!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaDocument!]!</b></code>](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of items returned for the current page.

      Contains the actual data items matching the search criteria, limited by the pagination settings. The array will be empty if no items match the search criteria.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items matching the search criteria.

      Represents the complete count of items that match the search filters, regardless of pagination. Used to calculate total pages and display result counts.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items displayed per page.

      Controls how many items are returned in each page of results. Used for pagination calculations and determining page boundaries.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number being displayed.

      Indicates which page of results is currently being shown. Pages start at 1 and increment based on the offset size.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of pages available.

      Calculated based on the total items found divided by the items per page. Used for pagination navigation and determining if there are more pages available.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Starting position number for items on the current page.

      Indicates the position of the first item displayed on this page within the complete result set. Useful for displaying "Showing X-Y of Z results" information.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaDocumentResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Ending position number for items on the current page.

      Indicates the position of the last item displayed on this page within the complete result set. Will not exceed the total number of items found.

### Returned By

[`mediaDocuments`](/reference/legacy/graphql-v1/deprecated/queries/media-documents.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductMedia`](/reference/legacy/graphql-v1/objects/product-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineMedia`](/reference/legacy/graphql-v1/objects/spare-parts-machine-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PaginatedMediaImageResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/paginated-media-image-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing image media items with navigation metadata

```graphql
type PaginatedMediaImageResponse {
  items: [MediaImage!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaImage!]!</b></code>](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of items returned for the current page.

      Contains the actual data items matching the search criteria, limited by the pagination settings. The array will be empty if no items match the search criteria.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items matching the search criteria.

      Represents the complete count of items that match the search filters, regardless of pagination. Used to calculate total pages and display result counts.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items displayed per page.

      Controls how many items are returned in each page of results. Used for pagination calculations and determining page boundaries.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number being displayed.

      Indicates which page of results is currently being shown. Pages start at 1 and increment based on the offset size.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of pages available.

      Calculated based on the total items found divided by the items per page. Used for pagination navigation and determining if there are more pages available.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Starting position number for items on the current page.

      Indicates the position of the first item displayed on this page within the complete result set. Useful for displaying "Showing X-Y of Z results" information.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaImageResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Ending position number for items on the current page.

      Indicates the position of the last item displayed on this page within the complete result set. Will not exceed the total number of items found.

### Returned By

[`mediaImages`](/reference/legacy/graphql-v1/deprecated/queries/media-images.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductMedia`](/reference/legacy/graphql-v1/objects/product-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineMedia`](/reference/legacy/graphql-v1/objects/spare-parts-machine-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PaginatedMediaVideoResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/paginated-media-video-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing video media items with navigation metadata

```graphql
type PaginatedMediaVideoResponse {
  items: [MediaVideo!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[MediaVideo!]!</b></code>](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Collection of items returned for the current page.

      Contains the actual data items matching the search criteria, limited by the pagination settings. The array will be empty if no items match the search criteria.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items matching the search criteria.

      Represents the complete count of items that match the search filters, regardless of pagination. Used to calculate total pages and display result counts.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items displayed per page.

      Controls how many items are returned in each page of results. Used for pagination calculations and determining page boundaries.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number being displayed.

      Indicates which page of results is currently being shown. Pages start at 1 and increment based on the offset size.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of pages available.

      Calculated based on the total items found divided by the items per page. Used for pagination navigation and determining if there are more pages available.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Starting position number for items on the current page.

      Indicates the position of the first item displayed on this page within the complete result set. Useful for displaying "Showing X-Y of Z results" information.

#### [<code style={{ fontWeight: 'normal' }}>PaginatedMediaVideoResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Ending position number for items on the current page.

      Indicates the position of the last item displayed on this page within the complete result set. Will not exceed the total number of items found.

### Returned By

[`mediaVideos`](/reference/legacy/graphql-v1/deprecated/queries/media-videos.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Media`](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductMedia`](/reference/legacy/graphql-v1/objects/product-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineMedia`](/reference/legacy/graphql-v1/objects/spare-parts-machine-media.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PayMethod

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/pay-method

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Payment method configuration for checkout and payment processing.

Represents a payment option available to customers during checkout including configuration details, branding, and integration settings. Used for payment processing, checkout flows, and financial transaction management.

```graphql
type PayMethod {
  id: Int!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  names: [LocalizedString!]!
  externalCode: String!
  logo: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier for the payment method.

    Primary key used to reference this payment method throughout the system for payment processing operations and checkout workflows.

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method creation timestamp.

    Date and time when this payment method was initially created in the system, used for auditing and payment method lifecycle tracking.

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method last modification timestamp.

    Date and time when any payment method configuration was last updated, used for change tracking and synchronization purposes.

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>names</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Localized payment method names for different languages.

    Collection of payment method names in various languages for international checkout experiences and multilingual storefronts. Each language must be unique within the collection.

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>externalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

External system identifier for payment processing integration.

    Unique code used to identify this payment method in external payment processors, gateways, and financial systems. Must follow SCREAMING&#x005F;SNAKE&#x005F;CASE format and be unique across all payment methods. Maximum 64 characters.

#### [<code style={{ fontWeight: 'normal' }}>PayMethod.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method logo URL for checkout display.

    URL pointing to the payment method's logo or icon, used for visual identification in checkout interfaces and payment selection screens. Maximum 255 characters.

### Returned By

[`payMethod`](/reference/legacy/graphql-v1/queries/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`payMethodCreate`](/reference/legacy/graphql-v1/mutations/pay-method-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`payMethodUpdate`](/reference/legacy/graphql-v1/mutations/pay-method-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`PayMethodsResponse`](/reference/legacy/graphql-v1/objects/pay-methods-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PayMethodsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/pay-methods-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing payment methods and pagination metadata.

Provides a structured response for payment method queries including the matching results and comprehensive pagination information for efficient data navigation.

```graphql
type PayMethodsResponse {
  items: [PayMethod!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[PayMethod!]!</b></code>](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type PayMethod

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>PayMethodsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`payMethods`](/reference/legacy/graphql-v1/queries/pay-methods.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## Payment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/payment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.

```graphql
type Payment {
  id: ID!
  userId: Int
  anonymousId: Int
  paymentId: String
  orderId: Int!
  amount: Int!
  currency: String!
  method: String!
  status: PaymentStatuses!
  transactions: [Transaction!]
  createdAt: DateTime!
  createdBy: String
  lastModifiedAt: DateTime!
  lastModifiedBy: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique system identifier for the payment record.

Primary key used to reference this payment throughout the system and for payment tracking operations.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Authenticated user identifier for the payment.

References the logged-in user who initiated this payment. Used for user-specific payment history and account management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>anonymousId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Anonymous user identifier for guest payments.

References the guest user session for payments made without authentication. Used for guest checkout tracking and order management. Must be a positive integer when provided.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment service provider identifier.

Unique payment reference provided by the Payment Service Provider (PSP) for tracking and reconciliation. Used for payment status updates and transaction matching. Maximum length of 255 characters. Must be unique across all payments.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order identifier associated with this payment.

References the specific order that this payment is intended to fulfill. Used for order-payment relationship tracking and fulfillment processing. Must be a positive integer.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment amount in smallest currency unit (cents).

The total amount to be paid expressed in the smallest denomination of the currency (e.g., cents for USD, pence for GBP). Used for precise financial calculations. Must be a positive integer.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment currency code in ISO 4217 format.

Three-letter currency code (e.g., USD, EUR, GBP) following ISO 4217 standard. Used for currency conversion and financial reporting. Must be exactly 3 uppercase letters.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method identifier used by the payment processor.

Specific payment method code used by the Payment Service Provider for processing this transaction (e.g., 'credit_card', 'paypal', 'bank_transfer'). Maximum length of 100 characters.

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaymentStatuses!</b></code>](/reference/legacy/graphql-v1/enums/payment-statuses.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Current payment processing status

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>transactions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Transaction!]</b></code>](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Collection of transactions associated with this payment for detailed financial tracking

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the payment record was initially created

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>createdBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the user who created the payment record

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the payment record was last modified

#### [<code style={{ fontWeight: 'normal' }}>Payment.<b>lastModifiedBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the user who last modified the payment record

### Returned By

[`payment`](/reference/legacy/graphql-v1/queries/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`paymentCreate`](/reference/legacy/graphql-v1/mutations/payment-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`paymentDelete`](/reference/legacy/graphql-v1/mutations/payment-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`paymentUpdate`](/reference/legacy/graphql-v1/mutations/payment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`PaymentsResponse`](/reference/legacy/graphql-v1/objects/payments-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PaymentsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/payments-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Paginated response containing payment records with navigation metadata.

Includes payment data along with pagination controls for efficient data browsing and client-side state management. Supports response expansion to include related transaction details.

```graphql
type PaymentsResponse {
  items: [Payment!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Payment!]!</b></code>](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Payment

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>PaymentsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`payments`](/reference/legacy/graphql-v1/queries/payments.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ProductDefaultPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-default-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductDefaultPrice {
  gross: Float
  taxCode: String
  productId: Int
  net(taxZone: String): Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductDefaultPrice.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Gross price value

#### [<code style={{ fontWeight: 'normal' }}>ProductDefaultPrice.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The taxCode of the product this price is calculated for

#### [<code style={{ fontWeight: 'normal' }}>ProductDefaultPrice.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ProductDefaultPrice.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>ProductDefaultPrice.net.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The taxZone used to calculate the net price. Overrules the taxZone applied to the parent field/query.

### Returned By

[`defaultPrice`](/reference/legacy/graphql-v1/queries/default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ProductInventory

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-inventory

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductInventory {
  productId: Int!
  totalQuantity: Int!
  supplierQuantity: Int!
  localQuantity: Int!
  nextDeliveryDate: DateTime
  balance: [Inventory!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Inventory product identifier

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>totalQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total product quantity

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>supplierQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Supplier product quantity

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>localQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Local product quantity

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>nextDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Inventory estimated next delivery date

#### [<code style={{ fontWeight: 'normal' }}>ProductInventory.<b>balance</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Inventory!]</b></code>](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Inventory items

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductMedia

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-media

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Media content associated with a specific product

```graphql
type ProductMedia {
  images(
    search: MediaImageProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaImageResponse
  videos(
    search: MediaVideoProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaVideoResponse
  documents(
    search: MediaDocumentProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaDocumentResponse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductMedia.<b>images</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Product-related images including photos, diagrams, and visual documentation.

    Contains all image media items associated with this product, such as product photos, technical diagrams, installation guides, and marketing materials.

##### [<code style={{ fontWeight: 'normal' }}>ProductMedia.images.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-image-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media images search options

#### [<code style={{ fontWeight: 'normal' }}>ProductMedia.<b>videos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Product-related videos including demonstrations, tutorials, and promotional content.

    Contains all video media items associated with this product, such as product demonstrations, installation tutorials, promotional videos, and technical explanations.

##### [<code style={{ fontWeight: 'normal' }}>ProductMedia.videos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-video-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media videos search options

#### [<code style={{ fontWeight: 'normal' }}>ProductMedia.<b>documents</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Product-related documents including manuals, specifications, and technical documentation.

    Contains all document media items associated with this product, such as user manuals, technical specifications, installation guides, and compliance certificates.

##### [<code style={{ fontWeight: 'normal' }}>ProductMedia.documents.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-document-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media documents search options

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductOffer

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-offer

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductOffer implements IProductOffer {
  id: String!
  price: Float!
  validFrom: DateTime!
  validTo: DateTime!
  formula: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductOffer.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the offer.

#### [<code style={{ fontWeight: 'normal' }}>ProductOffer.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The calculated price for this offer.

#### [<code style={{ fontWeight: 'normal' }}>ProductOffer.<b>validFrom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ProductOffer.<b>validTo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ProductOffer.<b>formula</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IProductOffer</b></code>](/reference/legacy/graphql-v1/interfaces/iproduct-offer.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the ProductOffer Type

### Member Of

[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductPrice {
  value: Float! @deprecated
  gross: Float!
  quantity: Int!
  discount: Discount
  taxCode: String!
  type: ProductPriceType!
  net(taxZone: String): Float
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>gross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Gross price value

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity this price was calculated for

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Discount</b></code>](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary " text="object"/>

The type of discount, if any, used to calculate the price

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The taxCode of the product this price is calculated for

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductPriceType!</b></code>](/reference/legacy/graphql-v1/enums/product-price-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The type of the price calculation

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>net</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>ProductPrice.net.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The taxZone used to calculate the net price. Overrules the taxZone applied to the parent field/query.

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>ProductPrice.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Product price value deprecated in favor of 'net' and 'gross' fields



Product price value

</Details>

### Returned By

[`explainPrice`](/reference/legacy/graphql-v1/queries/explain-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductSource

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product-source

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductSource {
  id: String
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductSource.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Source ID

#### [<code style={{ fontWeight: 'normal' }}>ProductSource.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Name of the source

### Member Of

[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBaseProduct`](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Product

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/product

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Product implements IResource, IBaseProduct, IProduct {
  id: Int!
  classId: Int! @deprecated
  categoryId: Int!
  attributes(
    filter: AttributeFilterInput
  ): [Attribute!]! @deprecated
  attributeValues(
    filter: AttributeFilterInput
  ): AttributeValueResponse!
  productId: Int!
  bundles(
    taxZone: String = "NL"
  ): [Bundle!]
  category: Category
  categoryPath: [Category!]!
  crossupsells(
    input: CrossupsellTypesInput
  ): [Crossupsell!]!
  favoriteLists(
    input: FavoriteListsSearchInput
  ): FavoriteListsResponse
  inventory: ProductInventory
  mediaImages(
    search: MediaImageProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaImageResponse @deprecated
  mediaVideos(
    search: MediaVideoProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaVideoResponse @deprecated
  mediaDocuments(
    search: MediaDocumentProductSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaDocumentResponse @deprecated
  media: ProductMedia
  orderlists(
    input: OrderlistSearchInput
  ): OrderlistsResponse!
  isAllowed(
    userId: Int!
    permission: Permission!
  ): Boolean!
  price(
    quantity: Int
    taxZone: String! = NL
    userId: Int
  ): ProductPrice
  bulkPrices(
    taxZone: String! = NL
  ): [BulkPrice!]
  language: String
  class: String!
  isHidden: YesNo!
  name(
    language: String
  ): [LocalizedString!]!
  description(
    language: String
  ): [LocalizedString!]!
  shortDescription(
    language: String
  ): [LocalizedString!]!
  slug(
    language: String
  ): [LocalizedString!]!
  sku: String!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
  shortName: String!
  manufacturerCode: String!
  eanCode: String!
  manufacturer: String!
  supplier: String!
  supplierCode: String!
  tag: String!
  taxCode: TaxCode!
  status: ProductStatus!
  isOrderable: YesNo!
  isReturnable: YesNo!
  hasBundle: YesNo!
  isBundleLeader: YesNo!
  package: String!
  packageUnit: String!
  packageUnitQuantity: String!
  priceDisplay: String!
  originalPrice: Float!
  costPrice: Float!
  suggestedPrice: Float!
  storePrice: Float!
  creditPoints: Float!
  minimumQuantity: Float!
  unit: Int!
  purchaseUnit: Int!
  purchaseMinimumQuantity: Int!
  econommicOrderQuantity: Int!
  orderableFrom: DateTime
  orderableTo: DateTime
  releaseDate: DateTime
  dateCreated: DateTime!
  dateChanged: DateTime!
  offers: [ProductOffer!]
  containerClass: String!
  cluster: Cluster
  surcharges: [Surcharge!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Resource primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>Product.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

This product's classID

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>bundles</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Bundle!]</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.bundles.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>category</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Category</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>categoryPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Category!]!</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>crossupsells</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Crossupsell!]!</b></code>](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.crossupsells.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CrossupsellTypesInput</b></code>](/reference/legacy/graphql-v1/inputs/crossupsell-types-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>favoriteLists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>inventory</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductInventory</b></code>](/reference/legacy/graphql-v1/objects/product-inventory.mdx) <Badge class="badge badge--secondary " text="object"/>

Product inventory

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>media</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductMedia</b></code>](/reference/legacy/graphql-v1/objects/product-media.mdx) <Badge class="badge badge--secondary " text="object"/>

Product media images

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>orderlists</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistsResponse!</b></code>](/reference/legacy/graphql-v1/objects/orderlists-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.orderlists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>isAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.isAllowed.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.isAllowed.<b>permission</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Permission!</b></code>](/reference/legacy/graphql-v1/enums/permission.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductPrice</b></code>](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.price.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order quantity to calculate the price for

##### [<code style={{ fontWeight: 'normal' }}>Product.price.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The taxZone used for calculating net price of the prices below.
Will likely be deprecated in the future in favor of adding the taxZone argument on the net() field instead

##### [<code style={{ fontWeight: 'normal' }}>Product.price.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The id of the user you want to calculate the price for. Defaults to the logged in user.
Can only be altered when the logged in user had sufficient permissions

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>bulkPrices</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BulkPrice!]</b></code>](/reference/legacy/graphql-v1/objects/bulk-price.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.bulkPrices.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The requested language for this this resource, default to the
products default language.
ISO 639-1 format.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the request resource

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>isHidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The hidden status of this resource.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>shortDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.shortDescription.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>Product.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Stock keeping unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>defaultLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default language for this product or cluster,
this is the language to fall back too, when there is no translation avaialbe in a specific language.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>priority</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order of the product in search results when sorting by priority.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>metadataTitle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata title available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>metadataDescription</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata description available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>metadataKeywords</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata keywords available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>metadataCanonicalUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

[SEO] Localized Metadata canonical url available in multiple languages

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>sources</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductSource!]!</b></code>](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>shortName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The short name product.
Commonly used for connections with third parties that
have a size limitation on the product name field.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The Original Equipment Manufacturer code for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>eanCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The European Article Number or barcode for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The manufacturer name for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The supplier of this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The supplierCode as it's know at the given supplier of this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tag of this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TaxCode!</b></code>](/reference/legacy/graphql-v1/enums/tax-code.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this product, either:
H = High
L = Low
N = No tax

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductStatus!</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The status of this product:

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>isOrderable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The orderable status of this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>isReturnable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The returnable status of this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is this product part of any product bundles.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo!</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Is this product leader of any product bundle.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>package</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package type for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>packageUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package unit for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>packageUnitQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The default package unit quantity for this product.

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>priceDisplay</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates how a product should be shown

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Original price of the product

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product cost price

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>suggestedPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product suggested price

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>storePrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product store price

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>creditPoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product credit points

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>minimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimum quantity

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>unit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product unit

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>purchaseUnit</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product purchase unit

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>purchaseMinimumQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimum purchasable quantity

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>econommicOrderQuantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product minimal economic order quantity

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>orderableFrom</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product orderable from date

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>orderableTo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product orderable to date

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>releaseDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product release date

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product creation date

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>dateChanged</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product last modified date

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>offers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductOffer!]</b></code>](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Available offers for this product and User. First item in the array should be regarded as the active price

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>containerClass</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The class of the product's container, can be either folder or cluster

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>cluster</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Cluster</b></code>](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>surcharges</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Surcharge!]</b></code>](/reference/legacy/graphql-v1/objects/surcharge.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of productId and clusterId



The class ID of the request resource

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Attribute!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated is favour of attributeValues.
Added pagination to ther query the default offset will be 12 values.
Increasing the offset in a listed view will impact the performance of the api.



Returns an array of legacy Attribute Entities

##### [<code style={{ fontWeight: 'normal' }}>Product.attributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>mediaImages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of `media.images`



Product media images

##### [<code style={{ fontWeight: 'normal' }}>Product.mediaImages.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaImageProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-image-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media images search options

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>mediaVideos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of `media.videos`



Product media videos

##### [<code style={{ fontWeight: 'normal' }}>Product.mediaVideos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaVideoProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-video-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media videos search options

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>mediaDocuments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of `media.documents`



Product media documents

##### [<code style={{ fontWeight: 'normal' }}>Product.mediaDocuments.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>MediaDocumentProductSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/media-document-product-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product media documents search options

#### [<code style={{ fontWeight: 'normal' }}>Product.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Path is no longer supported



The catalog path of this product.
Contains a list of ID's of categories with a / as delimiter

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IResource</b></code>](/reference/legacy/graphql-v1/interfaces/iresource.mdx) <Badge class="badge badge--secondary " text="interface"/>

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseProduct</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseProduct Type, where both Products and
clusters derive from

#### [<code style={{ fontWeight: 'normal' }}><b>IProduct</b></code>](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the Product Type

### Returned By

[`product`](/reference/legacy/graphql-v1/queries/product.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productCreate`](/reference/legacy/graphql-v1/mutations/product-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`productUpdate`](/reference/legacy/graphql-v1/mutations/product-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`BundleItem`](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Crossupsell`](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterOption`](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ProductsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/products-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ProductsResponse {
  items: [IBaseProduct!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
  minPrice: Int!
  maxPrice: Int!
  availableAttributes: [AttributeFilter!] @deprecated
  filters(filter: FilterAvailableAttributeInput): [AttributeFilter!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[IBaseProduct!]!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

List of items of type ProductResultUnion

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>minPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The lowest price of a product in this productlist

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>maxPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The highest price of a product in this productlist

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>filters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.filters.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FilterAvailableAttributeInput</b></code>](/reference/legacy/graphql-v1/inputs/filter-available-attribute-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Deprecated!

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>ProductsResponse.<b>availableAttributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of filters



</Details>

### Returned By

[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## PublishEmailEventResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/publish-email-event-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type PublishEmailEventResponse {
  success: Boolean!
  messageId: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>PublishEmailEventResponse.<b>success</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Did the publish event succeed?

#### [<code style={{ fontWeight: 'normal' }}>PublishEmailEventResponse.<b>messageId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Google Pub/Sub message id

### Returned By

[`publishEmailEvent`](/reference/legacy/graphql-v1/mutations/publish-email-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`publishEmailSendEvent`](/reference/legacy/graphql-v1/mutations/publish-email-send-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`publishPasswordResetEmailEvent`](/reference/legacy/graphql-v1/mutations/publish-password-reset-email-event.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RefreshTokenResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/refresh-token-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type RefreshTokenResponse {
  access_token: String!
  refresh_token: String!
  expires_in: Int!
  token_type: String!
  user_id: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RefreshTokenResponse.<b>access_token</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RefreshTokenResponse.<b>refresh_token</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RefreshTokenResponse.<b>expires_in</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RefreshTokenResponse.<b>token_type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RefreshTokenResponse.<b>user_id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`exchangeRefreshToken`](/reference/legacy/graphql-v1/mutations/exchange-refresh-token.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterContactResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/register-contact-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type RegisterContactResponse {
  contact: IBaseUser!
  session: RegisterUserSession!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactResponse.<b>contact</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterContactResponse.<b>session</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterUserSession!</b></code>](/reference/legacy/graphql-v1/objects/register-user-session.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`contactRegister`](/reference/legacy/graphql-v1/mutations/contact-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterCustomerResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/register-customer-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type RegisterCustomerResponse {
  customer: IBaseUser!
  session: RegisterUserSession!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerResponse.<b>customer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterCustomerResponse.<b>session</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterUserSession!</b></code>](/reference/legacy/graphql-v1/objects/register-user-session.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`customerRegister`](/reference/legacy/graphql-v1/mutations/customer-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterUserResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/register-user-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type RegisterUserResponse {
  user: IBaseUser!
  session: RegisterUserSession!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserResponse.<b>user</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserResponse.<b>session</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>RegisterUserSession!</b></code>](/reference/legacy/graphql-v1/objects/register-user-session.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`userRegister`](/reference/legacy/graphql-v1/mutations/user-register.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## RegisterUserSession

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/register-user-session

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type RegisterUserSession {
  accessToken: String!
  refreshToken: String!
  expirationTime: DateTime!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserSession.<b>accessToken</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserSession.<b>refreshToken</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>RegisterUserSession.<b>expirationTime</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`RegisterContactResponse`](/reference/legacy/graphql-v1/objects/register-contact-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterCustomerResponse`](/reference/legacy/graphql-v1/objects/register-customer-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterUserResponse`](/reference/legacy/graphql-v1/objects/register-user-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## SendOrderConfirmResponseType

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/send-order-confirm-response-type

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SendOrderConfirmResponseType {
  messageId: String!
  success: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SendOrderConfirmResponseType.<b>messageId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SendOrderConfirmResponseType.<b>success</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/deprecated/queries/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/mutations/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ShipmentItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/shipment-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ShipmentItem {
  id: Int!
  shipmentId: Int!
  orderItemId: Int!
  uuid: String!
  productId: Int
  sku: String!
  quantity: Int!
  name: String!
  supplier: String!
  supplierCode: String!
  price: Float!
  priceTotal: Float!
  discount: Float!
  tax: Float!
  taxPercentage: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>shipmentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>orderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order item unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>uuid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item UUID

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique identifier

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product SKU

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item quantity

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item name

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item description

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item supplier code

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item price

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>priceTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item total price

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>discount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item discount

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item tax

#### [<code style={{ fontWeight: 'normal' }}>ShipmentItem.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment item tax percentage

### Member Of

[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Shipment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/shipment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Shipment {
  id: Int!
  orderId: Int!
  status: String!
  date: DateTime!
  totalGross: Float!
  totalNet: Float!
  totalTax: Float!
  totalDiscountValue: Float!
  printDate: DateTime
  items: [ShipmentItem!]
  trackAndTrace: [TrackAndTrace!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment unique identifier

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order unique identifier

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment status

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment creation date

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>totalGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total gross amount of the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>totalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total net amount of the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>totalTax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total tax amount of the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>totalDiscountValue</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total discount value of the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>printDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Preferred delivery date for the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ShipmentItem!]</b></code>](/reference/legacy/graphql-v1/objects/shipment-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Items in the shipment

#### [<code style={{ fontWeight: 'normal' }}>Shipment.<b>trackAndTrace</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TrackAndTrace!]</b></code>](/reference/legacy/graphql-v1/objects/track-and-trace.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Track and trace information

### Member Of

[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ShopPriceCalculationConfig

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/shop-price-calculation-config

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ShopPriceCalculationConfig {
  isVatIncludedLeading: Boolean!
  inheritCatalogDiscountOnPriceList: Boolean!
  useMultipleCostprices: Boolean!
  calculateDiscountOverBulkPrices: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ShopPriceCalculationConfig.<b>isVatIncludedLeading</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ShopPriceCalculationConfig.<b>inheritCatalogDiscountOnPriceList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ShopPriceCalculationConfig.<b>useMultipleCostprices</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>ShopPriceCalculationConfig.<b>calculateDiscountOverBulkPrices</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Shop`](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Shop

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/shop

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Shop {
  shopId: Int!
  name: String!
  purchaseRootId: Int
  userRootId: Int
  enableIncentives: Boolean!
  priceCalculationConfig: ShopPriceCalculationConfig!
  debtorId: String
  cocNumber: String
  taxNumber: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>purchaseRootId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shop purchase root id

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>userRootId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shop customer root id

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>enableIncentives</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>priceCalculationConfig</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ShopPriceCalculationConfig!</b></code>](/reference/legacy/graphql-v1/objects/shop-price-calculation-config.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Shop price calculation configuration

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Shop.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`shop`](/reference/legacy/graphql-v1/queries/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`shops`](/reference/legacy/graphql-v1/queries/shops.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Channel`](/reference/legacy/graphql-v1/objects/channel.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Site

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/site

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Site {
  id: Int!
  url: String!
  alternartiveUrl: String
  mobileUrl: String!
  fileUrl: String!
  anonymousUserId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>alternartiveUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>mobileUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>fileUrl</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Site.<b>anonymousUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`site`](/reference/legacy/graphql-v1/deprecated/queries/site.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## SparePart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/spare-part

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SparePart {
  id: ID!
  sku: String!
  quantity: Int!
  name(language: String): [LocalizedString!]
  product: IBaseProduct
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SparePart.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Spare Part identifier

#### [<code style={{ fontWeight: 'normal' }}>SparePart.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Spare Part SKU

#### [<code style={{ fontWeight: 'normal' }}>SparePart.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Spare Part quantity

#### [<code style={{ fontWeight: 'normal' }}>SparePart.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Spare Part name

##### [<code style={{ fontWeight: 'normal' }}>SparePart.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePart.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseProduct</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary " text="interface"/>

### Member Of

[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsResponse`](/reference/legacy/graphql-v1/objects/spare-parts-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## SparePartsMachineMedia

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/spare-parts-machine-media

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SparePartsMachineMedia {
  images(
    search: ObjectMediaSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaImageResponse
  videos(
    search: ObjectMediaSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaVideoResponse
  documents(
    search: ObjectMediaSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaDocumentResponse
  attachments(
    input: ObjectMediaSearchInput = { page: 1, offset: 12 }
  ): PaginatedMediaAttachmentResponse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.<b>images</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaImageResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Media images

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.images.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ObjectMediaSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

SparePartsMachine media images search options

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.<b>videos</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaVideoResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Media videos

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.videos.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ObjectMediaSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

SparePartsMachine media videos search options

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.<b>documents</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaDocumentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Media documents

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.documents.<b>search</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ObjectMediaSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

SparePartsMachine media documents search options

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.<b>attachments</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaginatedMediaAttachmentResponse</b></code>](/reference/legacy/graphql-v1/objects/paginated-media-attachment-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Media attachments

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineMedia.attachments.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ObjectMediaSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

SparePartsMachine media attachments search options

### Member Of

[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## SparePartsMachineResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/spare-parts-machine-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SparePartsMachineResponse {
  items: [SparePartsMachine!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SparePartsMachine!]!</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type SparePartsMachine

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachineResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`machines`](/reference/legacy/graphql-v1/queries/machines.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## SparePartsMachine

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/spare-parts-machine

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SparePartsMachine {
  id: ID!
  parts: [SparePart!]
  media: SparePartsMachineMedia
  sparePartProducts(
    term: String
    manufacturer: [String!]
    supplierCode: [String!]
    supplier: [String!]
    manufacturerCode: [String!]
    EANCode: [String!]
    id: [Int!]
    classId: [Int!]
    class: ProductClass
    tag: [String!]
    language: String! = NL
    page: Int! = 1
    offset: Int! = 12
    textFilters: [TextFilterInput!]
    rangeFilters: [RangeFilterInput!]
    price: PriceFilterInput
    status: [ProductStatus!] = [A]
    hidden: Boolean
    sort: [SortInput!]
    searchFields: [SearchFieldsInput!]
    hasBundle: YesNo
    isBundleLeader: YesNo
    parentSlug: String
    pathSlug: String
    userId: Int
  ): SparePartsResponse
  name(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]
  slug(language: String): [LocalizedString!]
  machines: [SparePartsMachine!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The unique identifier for this Machine

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>parts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SparePart!]</b></code>](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>media</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SparePartsMachineMedia</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine-media.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>sparePartProducts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SparePartsResponse</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-response.mdx) <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.sparePartProducts.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.name.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.description.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.slug.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>SparePartsMachine.<b>machines</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SparePartsMachine!]</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`machine`](/reference/legacy/graphql-v1/queries/machine.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`machineCreate`](/reference/legacy/graphql-v1/mutations/machine-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`machineUpsert`](/reference/legacy/graphql-v1/mutations/machine-upsert.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineResponse`](/reference/legacy/graphql-v1/objects/spare-parts-machine-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## SparePartsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/spare-parts-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type SparePartsResponse {
  items: [SparePart!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
  minPrice: Int!
  maxPrice: Int!
  availableAttributes: [AttributeFilter!] @deprecated
  filters: [AttributeFilter!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SparePart!]!</b></code>](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type SpareParts

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>minPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The lowest price of a product in this productlist

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>maxPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The highest price of a product in this productlist

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>filters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>SparePartsResponse.<b>availableAttributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[AttributeFilter!]</b></code>](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated in favor of filters



</Details>

### Member Of

[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Surcharge

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/surcharge

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Surcharge {
  taxZone: String!
  taxCode: String!
  code: String!
  quantity: Int!
  amount: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Surcharge.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Surcharge.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Surcharge.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Surcharge.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Surcharge.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Member Of

[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Tax

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tax

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Tax {
  id: ID!
  shopId: Int!
  code: String
  zone: String!
  ratio: Float
  exportCode: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tax primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shop identifier for the tax to apply to

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax code

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>zone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tax zone

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>ratio</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax percentage expressed as ratio

#### [<code style={{ fontWeight: 'normal' }}>Tax.<b>exportCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tax export code

### Returned By

[`tax`](/reference/legacy/graphql-v1/queries/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`taxCreate`](/reference/legacy/graphql-v1/mutations/tax-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`taxDelete`](/reference/legacy/graphql-v1/mutations/tax-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`taxUpdate`](/reference/legacy/graphql-v1/mutations/tax-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`TaxesResponse`](/reference/legacy/graphql-v1/objects/taxes-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TaxesResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/taxes-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TaxesResponse {
  items: [Tax!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Tax!]!</b></code>](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Tax

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>TaxesResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`taxes`](/reference/legacy/graphql-v1/queries/taxes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## TenderAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderAddress {
  company: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  code: String
  email: String
  mobile: String
  phone: String
  fax: String
  url: String
  icp: YesNo
  notes: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address company

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Address contact gender

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address contact first name

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact middle name

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address contact last name

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Street

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Number extension

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Postal code

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

City

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Region

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Country code

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact email

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact mobile phone number

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact phone number

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>fax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact fax number

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address contact URL

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP is Yes when taxes do not apply for shipping to the given address/ country

#### [<code style={{ fontWeight: 'normal' }}>TenderAddress.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Notes, remarks, etc.

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderBaseItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-base-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderBaseItem implements ITenderBaseItem {
  id: Int!
  orderItemId: Int
  name: String!
  productId: Int!
  sku: String!
  quantity: Int!
  supplier: String!
  supplierCode: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  taxCode: Taxcode!
  taxPercentage: Int!
  customerDiscountPercentage: Float!
  discountPercentage: Float!
  totalDiscountPercentage: Float!
  marginAmount: Float!
  marginPercentage: Float!
  saleMarginAmount: Float!
  saleMarginPercentage: Float!
  attributedSaleDiscount: Float!
  attributedSaleMargin: Float!
  originalPrice: Float!
  costPrice: Float!
  customerPrice: Float!
  valuePoints: Int
  expectedDeliveryDate: DateTime
  externalOrderitemId: String
  notes: String!
  type: TenderOrderItemType!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the tender item, this id can be used for update or delete mutation for this tender item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>orderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Id of the order item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item name

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tender/order item's productId, if applicable

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item SKU

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier code

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>customerDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Sales discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>totalDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>marginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin amount (list price). VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>marginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin percentage (list price)

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>saleMarginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin amount. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>saleMarginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>attributedSaleDiscount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Extra item discount (%) calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>attributedSaleMargin</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product list price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product cost price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer special price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>externalOrderitemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order item's ID in an external system

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on tender item level

#### [<code style={{ fontWeight: 'normal' }}>TenderBaseItem.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderOrderItemType!</b></code>](/reference/legacy/graphql-v1/enums/tender-order-item-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order item type

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ITenderBaseItem</b></code>](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the TenderBaseItem Type, where both TenderBaseItem and TenderMainItem derive from

---

## TenderCarrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderCarrier {
  name: String!
  description: String!
  logo: String!
  amount: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderCarrier.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier name

#### [<code style={{ fontWeight: 'normal' }}>TenderCarrier.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier description

#### [<code style={{ fontWeight: 'normal' }}>TenderCarrier.<b>logo</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Carrier's logo

#### [<code style={{ fontWeight: 'normal' }}>TenderCarrier.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Costs for delivery through this carrier. Use the costs as an indication, the actual costs are calculated through business rules

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderMainItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-main-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderMainItem implements ITenderBaseItem {
  id: Int!
  productId: Int!
  product: Product
  orderItemId: Int
  name: String!
  sku: String!
  quantity: Int!
  supplier: String!
  supplierCode: String!
  price: Float!
  priceNet: Float!
  totalPrice: Float!
  totalPriceNet: Float!
  taxCode: Taxcode!
  taxPercentage: Int!
  customerDiscountPercentage: Float!
  discountPercentage: Float!
  totalDiscountPercentage: Float!
  marginAmount: Float!
  marginPercentage: Float!
  saleMarginAmount: Float!
  saleMarginPercentage: Float!
  attributedSaleDiscount: Float!
  attributedSaleMargin: Float!
  originalPrice: Float!
  costPrice: Float!
  customerPrice: Float!
  valuePoints: Int
  expectedDeliveryDate: DateTime
  externalOrderitemId: String
  notes: String!
  type: TenderOrderItemType!
  childItems: [ITenderBaseItem!]
  sum: Float!
  sumNet: Float!
  totalSum: Float!
  totalSumNet: Float!
  discountPercentageSum: Float!
  totalDiscountPercentageSum: Float!
  saleMarginAmountSum: Float!
  saleMarginPercentageSum: Float!
  attributedSaleDiscountSum: Float!
  attributedSaleMarginSum: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Id of the tender item, this id can be used for update or delete mutation for this tender item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tender/order item's productId, if applicable

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>product</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>orderItemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Id of the order item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item name

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item SKU

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The quantity for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order item supplier code

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>priceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalPriceNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax code for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage for this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>customerDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Sales discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalDiscountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total discount (%)

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>marginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin amount (list price). VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>marginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Default margin percentage (list price)

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>saleMarginAmount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin amount. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>saleMarginPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>attributedSaleDiscount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Extra item discount (%) calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>attributedSaleMargin</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage calculated based on tender/order total discount

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>originalPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product list price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>costPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product cost price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>customerPrice</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Customer special price per UOM of this tender/order item. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this tender/order item

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>expectedDeliveryDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>externalOrderitemId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order item's ID in an external system

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User notes on tender item level

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderOrderItemType!</b></code>](/reference/legacy/graphql-v1/enums/tender-order-item-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order item type

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>childItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ITenderBaseItem!]</b></code>](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="interface"/>

The tender/order item's child items. E.g. surcharges, incentives, etc.

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>sum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The gross price per UOM of this tender/order item, with item specific incentives and extra costs applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>sumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The price per UOM of this tender/order item, with item specific incentives and extra costs applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total gross price of this tender/order item, with item specific incentives and extra costs applied to this price. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalSumNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total price of this tender/order item, with item specific incentives and extra costs applied to this price. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>discountPercentageSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Sales discount (%). Includes item specific incentives and extra costs

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>totalDiscountPercentageSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total discount (%). Includes item specific incentives and extra costs

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>saleMarginAmountSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin amount. Includes item specific incentives and extra costs. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>saleMarginPercentageSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage. Includes item specific incentives and extra costs

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>attributedSaleDiscountSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Extra item discount (%) calculated based on tender/order total discount. Includes item specific incentives and extra costs

#### [<code style={{ fontWeight: 'normal' }}>TenderMainItem.<b>attributedSaleMarginSum</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Margin percentage calculated based on tender/order total discount. Includes item specific incentives and extra costs

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>ITenderBaseItem</b></code>](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the TenderBaseItem Type, where both TenderBaseItem and TenderMainItem derive from

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderPayment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-payment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderPayment {
  amountNet: Float!
  amountGross: Float!
  overruled: Boolean!
  tax: Float!
  taxPercentage: Float!
  method: String!
  status: String
  statusDate: DateTime
  transactionId: String
  accountingId: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>amountNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected paymethod on this tender/order. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>amountGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected paymethod on this tender/order. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

If false, payment costs are automatically calculated

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>tax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax associated with the selected paymethod on this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tax percentage associated with the selected paymethod on this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>method</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected payment method for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment status for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>statusDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment status change date for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>transactionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment transaction ID for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPayment.<b>accountingId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Accounting ID for this tender/order

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderPaymethod

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-paymethod

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderPaymethod {
  code: String!
  externalCode: String
  type: String
  description: String!
  taxCode: Taxcode!
  amount: Float!
  allowed: Boolean!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method code

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>externalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method external code

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Payment method type

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method description

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Payment method tax code

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Payment method amount

#### [<code style={{ fontWeight: 'normal' }}>TenderPaymethod.<b>allowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether payment method is allowed for the tender user

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderPostage

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-postage

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderPostage {
  shippingMethod: String!
  trackTrace: String!
  taxPercentage: Float!
  requestDate: DateTime!
  carrier: String!
  postageGross: Float!
  postageNet: Float!
  overruled: Boolean!
  partialDeliveryAllowed: Boolean
  pickUpLocationId: Int
  warehouse: Warehouse
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>shippingMethod</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected shipping method for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>trackTrace</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Track & Trace code

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>taxPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Postage tax percentage

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>requestDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The preferred delivery date for this order as requested by the user

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The selected carrier for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>postageGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected shipping method and business rules that apply to this tender/order. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>postageNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The costs associated with the selected shipping method and business rules that apply to this tender/order. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>overruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

If false, shipping costs are automatically calculated

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>partialDeliveryAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

This order can be shipped in parts when items different delivery dates

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>pickUpLocationId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Pick up location ID

#### [<code style={{ fontWeight: 'normal' }}>TenderPostage.<b>warehouse</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderProcessResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-process-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderProcessResponse {
  orderId: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderProcessResponse.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Returned By

[`tenderProcess`](/reference/legacy/graphql-v1/mutations/tender-process.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderResponseData

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-response-data

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderResponseData {
  data: JSONObject!
  error: Boolean!
  messages: [String!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderResponseData.<b>data</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject!</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Response data

#### [<code style={{ fontWeight: 'normal' }}>TenderResponseData.<b>error</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Error

#### [<code style={{ fontWeight: 'normal' }}>TenderResponseData.<b>messages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

Response message(s)

### Member Of

[`TenderResponse`](/reference/legacy/graphql-v1/objects/tender-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderResponse {
  tender: Tender!
  response: TenderResponseData!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderResponse.<b>tender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Tender!</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Tender

#### [<code style={{ fontWeight: 'normal' }}>TenderResponse.<b>response</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderResponseData!</b></code>](/reference/legacy/graphql-v1/objects/tender-response-data.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Tender response data

### Returned By

[`tenderAddItems`](/reference/legacy/graphql-v1/mutations/tender-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## TenderTaxLevel

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-tax-level

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderTaxLevel {
  taxCode: Taxcode!
  price: Float!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderTaxLevel.<b>taxCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Taxcode!</b></code>](/reference/legacy/graphql-v1/enums/taxcode.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

The tax level's tax code

#### [<code style={{ fontWeight: 'normal' }}>TenderTaxLevel.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total tax added to the tender/order for the tax level's tax code

### Member Of

[`TenderTotal`](/reference/legacy/graphql-v1/objects/tender-total.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TenderTotal

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender-total

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type TenderTotal {
  subTotal: Float!
  subTotalNet: Float!
  discountPercentage: Float!
  discountType: DiscountType!
  discountOverruled: Boolean!
  totalNet: Float!
  totalGross: Float!
  discountNet: Float!
  discountGross: Float!
  totalTax: Float!
  taxLevels: [TenderTaxLevel!]
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>subTotal</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount of all items in this tender/order, excluding postage costs, paymethod costs and discounts. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>subTotalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount of all items in this tender/order, excluding postage costs, paymethod costs and discounts. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>discountPercentage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount percentage that is applied to the tender/order total through one or multiple incentives

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>discountType</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DiscountType!</b></code>](/reference/legacy/graphql-v1/enums/discount-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Discount type

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>discountOverruled</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

If false, discount is automatically calculated

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>totalNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount for this tender/order. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>totalGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The total payable amount for this tender/order. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>discountNet</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount that is applied to the tender/order total through one or multiple incentives. VAT including

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>discountGross</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Discount that is applied to the tender/order total through one or multiple incentives. VAT excluding

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>totalTax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of tax that applies to this tender/order

#### [<code style={{ fontWeight: 'normal' }}>TenderTotal.<b>taxLevels</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderTaxLevel!]</b></code>](/reference/legacy/graphql-v1/objects/tender-tax-level.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Amount of tax that applies to this tender/order per tax code

### Member Of

[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Tender

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/tender

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Tender {
  tenderId: String!
  orderId: Int
  type: TenderOrderType!
  siteId: Int @deprecated
  channelId: Int
  shopId: Int!
  date: DateTime!
  userId: Int!
  invoiceUserId: Int
  status: String!
  firstName: String!
  middleName: String!
  lastName: String!
  email: String!
  debtorId: String!
  invoiceAddress: TenderAddress
  deliveryAddress: TenderAddress
  itemCount: Int
  items: [TenderMainItem!]
  paymentData: TenderPayment
  postageData: TenderPostage
  total: TenderTotal
  carriers: [TenderCarrier!]
  payMethods: [TenderPaymethod!]
  source: String
  valuePoints: Int
  incentivesApplied: Boolean
  creditPoints: Int
  couponCode: String
  actionCode: String
  reference: String
  remarks: String
  externalId: String
  extra3: String
  extra4: String
  isEditable: Boolean!
  user: IBaseUser!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The tender's primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tender's associated order ID

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderOrderType!</b></code>](/reference/legacy/graphql-v1/enums/tender-order-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Order type

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The channel id the tender/order is created from

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The shop the tender/order belongs to

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>date</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The date this tender/order has been created

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The ID of the user applied to this tender

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>invoiceUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The invoice userId for this tender

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Tender/order status

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User's first name

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User's middle name

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User's last name

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

User's email

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Invoice company debtor ID

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>invoiceAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderAddress</b></code>](/reference/legacy/graphql-v1/objects/tender-address.mdx) <Badge class="badge badge--secondary " text="object"/>

The address the invoice for the order should be sent to

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>deliveryAddress</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderAddress</b></code>](/reference/legacy/graphql-v1/objects/tender-address.mdx) <Badge class="badge badge--secondary " text="object"/>

The address the order should be shipped to

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>itemCount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tender/order main item count

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderMainItem!]</b></code>](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

The tender/order items

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>paymentData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderPayment</b></code>](/reference/legacy/graphql-v1/objects/tender-payment.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment data for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>postageData</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderPostage</b></code>](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary " text="object"/>

Postage data for this tender/order

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>total</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TenderTotal</b></code>](/reference/legacy/graphql-v1/objects/tender-total.mdx) <Badge class="badge badge--secondary " text="object"/>

Tender total

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>carriers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderCarrier!]</b></code>](/reference/legacy/graphql-v1/objects/tender-carrier.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable carriers

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>payMethods</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TenderPaymethod!]</b></code>](/reference/legacy/graphql-v1/objects/tender-paymethod.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

List of selectable payment methods for this tender, including non allowed for the applied user

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tender/order origin

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>valuePoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Total amount of valuePoints that apply to this tender/order

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>incentivesApplied</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether incentives are already applied

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>creditPoints</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Tender/order accumulated credit points

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>couponCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Coupon code that is applied to this tender. Is only filled if a valid coupon code was applied during checkout

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>actionCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Action code that is applied to this tender. Is only filled if a valid action code was applied during checkout

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>reference</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's reference for this tender

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>remarks</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

User's remarks for this tender

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The order's ID in an external system

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>extra3</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a tender/order

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>extra4</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional information field that can be stored with a tender/order

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>isEditable</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Indicates whether tender can be edited

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>user</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>IBaseUser!</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="interface"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Tender.<b>siteId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary " text="scalar"/>



Deprecated in favor of channelId



The site id the tender/order is created from

</Details>

### Returned By

[`tender`](/reference/legacy/graphql-v1/queries/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`tenderApplyIncentives`](/reference/legacy/graphql-v1/mutations/tender-apply-incentives.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderDeleteItem`](/reference/legacy/graphql-v1/mutations/tender-delete-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderStart`](/reference/legacy/graphql-v1/mutations/tender-start.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdate`](/reference/legacy/graphql-v1/mutations/tender-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdateAddress`](/reference/legacy/graphql-v1/mutations/tender-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdateDiscount`](/reference/legacy/graphql-v1/mutations/tender-update-discount.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdateInvoiceUser`](/reference/legacy/graphql-v1/mutations/tender-update-invoice-user.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdateItem`](/reference/legacy/graphql-v1/mutations/tender-update-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdatePayment`](/reference/legacy/graphql-v1/mutations/tender-update-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderUpdatePostage`](/reference/legacy/graphql-v1/mutations/tender-update-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`TenderResponse`](/reference/legacy/graphql-v1/objects/tender-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## TrackAndTrace

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/track-and-trace

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Package tracking and shipment monitoring record.

Represents a tracking entry for shipments handled by carriers, providing linkage between tracking information and carrier services for comprehensive shipment visibility.

```graphql
type TrackAndTrace {
  carrierId: Int
  carrier: Carrier
  id: Int!
  orderId: Int!
  shipmentId: Int!
  code: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>carrierId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Carrier unique identifier

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>carrier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Retrieve the shipping carrier associated with this tracking record.

    Returns the carrier information including service details, coverage areas, and integration settings used for this shipment. Used to display carrier-specific tracking information and branding.

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Track and trace unique identifier

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order unique identifier

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>shipmentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Shipment unique identifier

#### [<code style={{ fontWeight: 'normal' }}>TrackAndTrace.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Track and trace code

### Member Of

[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Transaction

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/transaction

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Transaction record representing individual payment processing operations.

Tracks specific payment operations such as authorizations, captures, refunds, and chargebacks. Each transaction is linked to a parent payment and contains detailed processing information including amounts, timestamps, and status updates.

```graphql
type Transaction {
  id: ID!
  transactionId: String!
  paymentId: String
  orderId: Int!
  amount: Int!
  currency: String!
  description: String
  timestamp: DateTime
  type: TransactionTypes!
  provider: String
  status: TransactionStatuses!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique system identifier for the transaction record

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>transactionId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

External transaction identifier provided by the payment service provider for tracking and reconciliation.

Unique transaction reference provided by the Payment Service Provider (PSP) for tracking and reconciliation. Used for transaction status updates and matching with external systems. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>paymentId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External payment identifier provided by the payment service provider for correlation.

External payment identifier provided by the Payment Service Provider for correlation with parent payment. Used to link transactions to their originating payments in external systems. Maximum length of 255 characters.

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Order identifier associated with this transaction.

References the specific order that this transaction is processing. Used for order-transaction relationship tracking and fulfillment processing. Must be a positive integer.

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>amount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Transaction amount in smallest currency unit (cents).

The transaction amount expressed in the smallest denomination of the currency (e.g., cents for USD, pence for GBP). Used for precise financial calculations. Must be a positive integer.

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>currency</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Transaction currency code in ISO 4217 format for international financial transactions.

Three-letter currency code (e.g., USD, EUR, GBP) following ISO 4217 standard. Used for currency conversion and financial reporting. Must be exactly 3 uppercase letters.

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Human-readable description of the transaction purpose or details

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>timestamp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Timestamp when the transaction was processed by the payment service provider

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransactionTypes!</b></code>](/reference/legacy/graphql-v1/enums/transaction-types.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Type of transaction operation performed

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>provider</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Name of the payment service provider that processed the transaction

#### [<code style={{ fontWeight: 'normal' }}>Transaction.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TransactionStatuses!</b></code>](/reference/legacy/graphql-v1/enums/transaction-statuses.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Current processing status of the transaction

### Member Of

[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## UserClaims

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/user-claims

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type UserClaims {
  userId: Int!
  userDirectoryId: Int!
  adminUserId: Int!
  companyId: Int
  roles: [String!]!
  discounts: [String!]!
  acllist: [Int!]!
  class: String!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>userDirectoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>adminUserId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>roles</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>discounts</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>acllist</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>UserClaims.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

---

## User

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type User implements IBaseUser {
  userId: Int!
  addresses(type: AddressType, isDefault: YesNo): [Address!]!
  id: Int! @deprecated
  attributes(filter: AttributeFilterInput): [Attribute!]! @deprecated
  attributeValues(filter: AttributeFilterInput): AttributeValueResponse!
  orders: OrderResponse!
  aclList(permission: Permission!): [Int!]!
  isAllowed(userId: Int!, permission: Permission!): Boolean!
  debtorId: String
  gender: Gender
  firstName: String!
  middleName: String
  lastName: String!
  phone: String
  mobile: String
  email: String!
  iban: String
  bankAccount: String
  bic: String
  notes: String
  primaryLanguage: String
  expires: DateTime
  externalId: String
  dateOfBirth: DateTime
  mailingList: YesNo
  isLoggedIn: Boolean
  dateCreated: DateTime
  lastModifiedDate: DateTime
  taxNumber: String
  cocNumber: String
  loginRoot: Int
  company: String
  parentUsergroupId: Int!
  managedCompanies: [Company!]
  usergroup: Usergroup
  usergroupPath: [Usergroup!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>User.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>addresses</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Address!]!</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

##### [<code style={{ fontWeight: 'normal' }}>User.addresses.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

##### [<code style={{ fontWeight: 'normal' }}>User.addresses.<b>isDefault</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>attributeValues</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse!</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Returns a paginated response of AttributeValues

##### [<code style={{ fontWeight: 'normal' }}>User.attributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>orders</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderResponse!</b></code>](/reference/legacy/graphql-v1/objects/order-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>aclList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>User.aclList.<b>permission</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Permission!</b></code>](/reference/legacy/graphql-v1/enums/permission.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>isAllowed</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>User.isAllowed.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

##### [<code style={{ fontWeight: 'normal' }}>User.isAllowed.<b>permission</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Permission!</b></code>](/reference/legacy/graphql-v1/enums/permission.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>debtorId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

The gender of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The first name of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The middle name of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The last name of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The phone number of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The mobile number of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The email of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>iban</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The International Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>User.<b>bankAccount</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Account Number of the user

#### [<code style={{ fontWeight: 'normal' }}>User.<b>bic</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Bank Identification Code of the user

#### [<code style={{ fontWeight: 'normal' }}>User.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>primaryLanguage</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The primary language of the user

#### [<code style={{ fontWeight: 'normal' }}>User.<b>expires</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The expiration date of the contact. After this date expires contact will be disabled.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>externalId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

External ID

#### [<code style={{ fontWeight: 'normal' }}>User.<b>dateOfBirth</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The date of birth of the contact.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>mailingList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>isLoggedIn</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>taxNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The Tax number of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>cocNumber</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The CoC number of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>loginRoot</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The propeller access root for this user. Users with a login root can log into the backoffice and have a supervisor role on the api's

#### [<code style={{ fontWeight: 'normal' }}>User.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The company of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>parentUsergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The usergroup id of parent usergroup.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>managedCompanies</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Company!]</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="object"/>

Companies managed by the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>usergroup</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>User.<b>usergroupPath</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Usergroup!]!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>User.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use userId instead.



The unique identifier of the user.

#### [<code style={{ fontWeight: 'normal' }}>User.<b>attributes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Attribute!]!</b></code>](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>



Deprecated is favour of attributeValues.
Added pagination to ther query the default offset will be 12 values.
Increasing the offset in a listed view will impact the performance of the api.



Returns an array of legacy Attribute Entities

##### [<code style={{ fontWeight: 'normal' }}>User.attributes.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

</Details>

### Interfaces

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

---

## Usergroup

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/usergroup

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Usergroup {
  id: Int! @deprecated
  usergroupId: Int!
  name: String!
  hidden: YesNo
  inheritProductList: YesNo
  path: String
  slug: String
  tag: String
  dateCreated: DateTime
  lastModifiedDate: DateTime
  parentUsergroupId: Int!
  usergroup: Usergroup!
  usergroups: [Usergroup!]!
  companies(
    input: CompanySearchArguments = {
      managedCompaniesOnly: false
      page: 1
      offset: 12
    }
  ): CompaniesResponse
  customers: [Customer!]!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>usergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of the usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The name of the usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Shows whether this usergroup is hidden and should only be used for background operations.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>inheritProductList</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The path in id's to the root of the inheritance tree.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The slug of the usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The slug of the usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>dateCreated</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>lastModifiedDate</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>parentUsergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The id of parent usergroup.

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>usergroup</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Usergroup!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>usergroups</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Usergroup!]!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>companies</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompaniesResponse</b></code>](/reference/legacy/graphql-v1/objects/companies-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Children companies of the usergroup.

##### [<code style={{ fontWeight: 'normal' }}>Usergroup.companies.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchArguments</b></code>](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>customers</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Customer!]!</b></code>](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

<Details dataOpen="Hide deprecated" dataClose="Show deprecated">

#### [<code style={{ fontWeight: 'normal' }}>Usergroup.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--deprecated" text="deprecated"/> <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>



This property is no longer relevant or necessary, use usergroupId instead.



The unique identifier of the usergroup.

</Details>

### Returned By

[`usergroup`](/reference/legacy/graphql-v1/queries/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`usergroupCreate`](/reference/legacy/graphql-v1/mutations/usergroup-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`usergroupUpdate`](/reference/legacy/graphql-v1/mutations/usergroup-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UsergroupsResponse`](/reference/legacy/graphql-v1/objects/usergroups-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## UsergroupsResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/usergroups-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type UsergroupsResponse {
  items: [Usergroup!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Usergroup!]!</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Usergroup

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>UsergroupsResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`usergroups`](/reference/legacy/graphql-v1/queries/usergroups.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## ValuesetItemResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/valueset-item-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ValuesetItemResponse {
  items: [ValuesetItem!]!
  itemsFound: Float!
  offset: Float!
  page: Float!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ValuesetItem!]!</b></code>](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Array of value set items matching the search criteria with complete data and localized descriptions

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of value set items found matching the search criteria across all pages

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page used for pagination to control result set size

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number in the pagination sequence for navigating through results

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItemResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`valuesetItems`](/reference/legacy/graphql-v1/queries/valueset-items.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ValuesetItem

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/valueset-item

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ValuesetItem {
  id: Int!
  valuesetId: Int!
  value: String!
  descriptions: [LocalizedString!]!
  extra: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItem.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique system identifier for this value set item used for referencing and database operations

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItem.<b>valuesetId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Reference to the parent value set that contains this item, establishing the hierarchical relationship

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItem.<b>value</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The actual data value that this item represents, used as the key for selection and processing throughout the system

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItem.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Human-readable labels for this value set item in multiple languages, displayed to users in dropdown lists and selection interfaces

#### [<code style={{ fontWeight: 'normal' }}>ValuesetItem.<b>extra</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Additional metadata or supplementary information associated with this value set item for extended functionality and context

### Returned By

[`valuesetItemCreate`](/reference/legacy/graphql-v1/mutations/valueset-item-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`valuesetItemUpdate`](/reference/legacy/graphql-v1/mutations/valueset-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`ValuesetItemResponse`](/reference/legacy/graphql-v1/objects/valueset-item-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## ValuesetResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/valueset-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type ValuesetResponse {
  items: [Valueset!]!
  itemsFound: Float!
  offset: Float!
  page: Float!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Valueset!]!</b></code>](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Array of value sets matching the search criteria with complete configuration and metadata information

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of value sets found matching the search criteria across all pages

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Number of items per page used for pagination to control result set size

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Current page number in the pagination sequence for navigating through results

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>ValuesetResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`valuesets`](/reference/legacy/graphql-v1/queries/valuesets.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## Valueset

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/valueset

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Valueset {
  id: Int!
  name: String!
  type: ValuesetType!
  descriptions: [LocalizedString!]!
  lastModifiedBy: Int
  lastModifiedAt: DateTime!
  createdBy: Int
  createdAt: DateTime!
  valuesetItems(input: ValuesetItemSearchInput): ValuesetItemResponse!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Valueset primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier name for the value set used throughout the system for referencing and configuration purposes

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetType!</b></code>](/reference/legacy/graphql-v1/enums/valueset-type.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

Classification indicating whether this value set is system-managed or user-customizable

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>descriptions</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[LocalizedString!]!</b></code>](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Human-readable descriptions of the value set purpose and usage in multiple languages for internationalization support

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>lastModifiedBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the user who last modified this value set for audit trail purposes

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp indicating when this value set was last modified for tracking changes and audit purposes

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>createdBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Identifier of the user who originally created this value set for audit trail purposes

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Timestamp indicating when this value set was originally created for audit trail and historical tracking

#### [<code style={{ fontWeight: 'normal' }}>Valueset.<b>valuesetItems</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemResponse!</b></code>](/reference/legacy/graphql-v1/objects/valueset-item-response.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Retrieve items belonging to this value set with filtering and pagination.

    Returns all items associated with the value set including their values, localized descriptions, and additional metadata. Used for populating dropdown lists, validation options, and configuration interfaces.

    This field resolver automatically filters items to only those belonging to the current value set, providing a convenient way to access related data in GraphQL queries.

    Use this field to:
    • Populate dropdown lists with value set options
    • Display all available choices for configuration
    • Implement search and filtering within value set items
    • Access localized labels for internationalization

    Possible errors:
    - VALUESET&#x005F;ITEM&#x005F;LIST&#x005F;ERROR: Failed to retrieve value set items due to system error

##### [<code style={{ fontWeight: 'normal' }}>Valueset.valuesetItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/valueset-item-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria and pagination parameters for filtering value set items.

      All search parameters are optional. When provided, they filter the items within this specific value set. Pagination controls help manage large item collections efficiently.

      The valuesetIds parameter is automatically set to the current value set, so it should not be provided in the input.

### Returned By

[`valueset`](/reference/legacy/graphql-v1/queries/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`valuesetCreate`](/reference/legacy/graphql-v1/mutations/valueset-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`valuesetUpdate`](/reference/legacy/graphql-v1/mutations/valueset-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`ValuesetResponse`](/reference/legacy/graphql-v1/objects/valueset-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## VerifyToken

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/verify-token

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type VerifyToken {
  uid: String!
  name: String!
  claims: JSONObject
  iss: String!
  aud: String!
  auth_time: Int!
  user_id: String!
  sub: String!
  iat: Int!
  exp: Int!
  email: String!
  email_verified: Boolean!
  firebase: Firebase
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>uid</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>claims</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>iss</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>aud</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>auth_time</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>user_id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>sub</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>iat</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>exp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>email_verified</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>VerifyToken.<b>firebase</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Firebase</b></code>](/reference/legacy/graphql-v1/objects/firebase.mdx) <Badge class="badge badge--secondary " text="object"/>

### Returned By

[`verifyToken`](/reference/legacy/graphql-v1/mutations/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## WarehouseAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/warehouse-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type WarehouseAddress {
  id: Int!
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  fax: String
  code: String
  notes: String
  icp: YesNo
  url: String
  name: String
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address primary identifier

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>firstName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

First name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>middleName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Middle name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>lastName</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Last name the address applies to

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>gender</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Gender</b></code>](/reference/legacy/graphql-v1/enums/gender.mdx) <Badge class="badge badge--secondary " text="enum"/>

Address gender

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>company</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Company the address applies to

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>street</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address street

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>number</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>numberExtension</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address street number extension

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>postalCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address postal code

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>city</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address city

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>region</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address region

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>country</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Address country

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>phone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fixed phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>mobile</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Mobile phone number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Email that applies to this address [valid email format needed]

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>fax</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Fax number that applies to this address [min: 6, max: 30]

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address code

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address delivery notes

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>icp</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>url</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address company domain url

#### [<code style={{ fontWeight: 'normal' }}>WarehouseAddress.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address friendly descriptive name

### Returned By

[`warehouseAddressCreate`](/reference/legacy/graphql-v1/mutations/warehouse-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseAddressUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Warehouse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type Warehouse {
  id: ID!
  addressId: Int
  address: WarehouseAddress
  name: String!
  description: String!
  notes: String!
  isActive: Boolean!
  isStore: Boolean!
  isPickupLocation: Boolean!
  shopId: Int
  businessHours: [BusinessHours!]!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse primary identifier

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>addressId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Address identifier associated with the warehouse

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>address</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>WarehouseAddress</b></code>](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary " text="object"/>

Warehouse Address

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse name

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>description</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse description

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>notes</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse notes

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>isActive</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isActive status

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>isStore</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isStore status

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>isPickupLocation</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean!</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse isPickupLocation status

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Optional warehouse shopId

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>businessHours</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[BusinessHours!]!</b></code>](/reference/legacy/graphql-v1/objects/business-hours.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

Warehouse business hours per week day

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>createdAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse initial creation timestamp

#### [<code style={{ fontWeight: 'normal' }}>Warehouse.<b>lastModifiedAt</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>DateTime!</b></code>](/reference/legacy/graphql-v1/scalars/date-time.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Warehouse last update timestamp

### Returned By

[`warehouse`](/reference/legacy/graphql-v1/queries/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`warehouseCreate`](/reference/legacy/graphql-v1/mutations/warehouse-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseDelete`](/reference/legacy/graphql-v1/mutations/warehouse-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehousesResponse`](/reference/legacy/graphql-v1/objects/warehouses-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## WarehousesResponse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/objects/warehouses-response

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
type WarehousesResponse {
  items: [Warehouse!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>items</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Warehouse!]!</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/>

List of items of type Warehouse

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>itemsFound</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total number of items found

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The amount of items to show per page

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

The current page

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>pages</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Total amount of pages

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>start</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Start position of the current page

#### [<code style={{ fontWeight: 'normal' }}>WarehousesResponse.<b>end</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

End position of the current page

### Returned By

[`warehouses`](/reference/legacy/graphql-v1/queries/warehouses.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

---

## addressesByCompanyId

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/addresses-by-company-id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

```graphql
addressesByCompanyId(
  companyId: Float!
  type: AddressType
): [Address!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addressesByCompanyId.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>addressesByCompanyId.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## addressesByCustomerId

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/addresses-by-customer-id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

```graphql
addressesByCustomerId(
  customerId: Float!
  type: AddressType
): [Address!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addressesByCustomerId.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>addressesByCustomerId.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## addressesByOrderId

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/addresses-by-order-id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

```graphql
addressesByOrderId(
  orderId: Float!
  type: AddressType
): [Address!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addressesByOrderId.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>addressesByOrderId.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## addressesByUserId

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/addresses-by-user-id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

```graphql
addressesByUserId(
  userId: Float!
  type: AddressType
): [Address!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>addressesByUserId.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>addressesByUserId.<b>type</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AddressType</b></code>](/reference/legacy/graphql-v1/enums/address-type.mdx) <Badge class="badge badge--secondary " text="enum"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Address</b></code>](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## attributeClassIdsByNameAndValue

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/attribute-class-ids-by-name-and-value

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Returns IDs of objects that searched attribute is applied.
This query is used to search users/products etc. by attribute/attributeValue
This query can only be used in inner calls.

```graphql
attributeClassIdsByNameAndValue(
  input: AttributeValueObjectSearchInput
): [Int!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>attributeClassIdsByNameAndValue.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeValueObjectSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

---

## attributeDescription

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/attribute-description

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
attributeDescription(
  input: AttributeDescriptionSearchInput!
): AttributeDescriptionResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>attributeDescription.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeDescriptionSearchInput!</b></code>](/reference/legacy/graphql-v1/inputs/attribute-description-search-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>AttributeDescriptionResponse</b></code>](/reference/legacy/graphql-v1/objects/attribute-description-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## authentication

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/authentication

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Fetches a GCIP user by email address, used to check for existing email addresses in GCIP.

```graphql
authentication(
  email: String!
): GCIPUser!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>authentication.<b>email</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>GCIPUser</b></code>](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## bulkPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/bulk-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
bulkPrice(
  productId: Float!
  userId: Float
  taxZone: String! = NL
): [BulkPrice!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bulkPrice.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>bulkPrice.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>bulkPrice.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BulkPrice</b></code>](/reference/legacy/graphql-v1/objects/bulk-price.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## bundle

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/bundle

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
bundle(
  bundleId: Float
  taxZone: String = "NL"
  input: BundleSearchInput
): Bundle!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundle.<b>bundleId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

[DEPRECATED] Use `input.id` instead.]

#### [<code style={{ fontWeight: 'normal' }}>bundle.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

[DEPRECATED] Use `input.taxZone` instead.]

#### [<code style={{ fontWeight: 'normal' }}>bundle.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BundleSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/bundle-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Bundle</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## bundles

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/bundles

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
bundles(
  productId: [Float!]!
  taxZone: String = "NL"
): [Bundle!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>bundles.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Float!]!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>bundles.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Bundle</b></code>](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## businessRuleDecisionTable

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/business-rule-decision-table

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve a specific decision table from a business rule by its identifiers.

Returns the complete decision table structure including rows, columns, expressions, and hit policy configuration.
Used for decision table management, rule editing, and business logic inspection.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_DECISION_TABLE_NOT_FOUND_ERROR: Decision table with the specified ID does not exist within the rule

```graphql
businessRuleDecisionTable(
  input: BusinessRuleDecisionTableSearchInput!
): BusinessRuleDecisionTable!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleDecisionTable.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTableSearchInput!</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-search-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Search criteria containing the business rule ID and decision table ID to retrieve

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleDecisionTable</b></code>](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary " text="object"/>

Decision table node containing the core business logic organized in tabular format.

Each decision table consists of multiple rows where each row represents a specific business rule with conditions and actions.
The hit policy determines the execution strategy when multiple rules match the input criteria.
Tables support complex expressions, conditional logic, and multi-criteria decision making for comprehensive business rule automation.

---

## businessRuleFieldDefinitions

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/business-rule-field-definitions

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve field definitions for business rule input and output mapping by group name.

Returns the complete field definition group containing all available fields, their types, paths, and validation rules.
Used for building business rule expressions, input validation, and output formatting.

Possible errors:

- BUSINESS_DEFINITIONS_NOT_FOUND: Field definition group with the specified name does not exist

```graphql
businessRuleFieldDefinitions(
  name: String!
): BusinessRuleFieldDefinitionGroup!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleFieldDefinitions.<b>name</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Name of the field definition group to retrieve (e.g., 'order', 'customer', 'product')

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleFieldDefinitionGroup</b></code>](/reference/legacy/graphql-v1/objects/business-rule-field-definition-group.mdx) <Badge class="badge badge--secondary " text="object"/>

Collection of related field definitions organized by domain context for business rule mapping.

Groups field definitions by logical domains (e.g., order, customer, product) to provide organized access to available fields.
Supports hierarchical organization with root groups and nested structures for complex data modeling.

---

## businessRuleJDM

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/business-rule-jdm

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Convert a business rule to JSON Decision Model (JDM) format for execution in compatible rule engines.

Returns the standardized JDM representation that can be consumed by GoRules Zen Engine and other compatible rule execution platforms.
The JDM format includes all rule logic, conditions, actions, and metadata required for runtime execution.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_TO_JDM_ERROR: Failed to convert business rule to JDM format due to invalid rule structure

```graphql
businessRuleJDM(
  id: ID!
  language: String = "EN"
): JSONObject!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRuleJDM.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the business rule to convert to JDM format

#### [<code style={{ fontWeight: 'normal' }}>businessRuleJDM.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language code for localized content generation (ISO 639-1 format, defaults to 'EN')

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>JSONObject</b></code>](/reference/legacy/graphql-v1/scalars/jsonobject.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).

---

## businessRule

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/business-rule

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve detailed information about a specific business rule by its unique identifier.

Returns comprehensive business rule data including the complete graph structure with nodes, edges, decision tables, and execution logic.
Used for business rule management, workflow automation, and rule configuration interfaces.

Possible errors:

- BUSINESS_RULE_NOT_FOUND: Business rule with the specified ID does not exist
- BUSINESS_RULE_UNKNOWN_ERROR: Unexpected error occurred during rule retrieval

```graphql
businessRule(
  id: ID!
): BusinessRule!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRule.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID!</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the business rule to retrieve from the system

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRule</b></code>](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary " text="object"/>

Complete business rule workflow represented as a directed graph structure.

Each business rule consists of interconnected nodes (input, decision tables, output) connected by edges that define the execution flow.
Decision tables contain multiple rows where each row represents a specific rule condition and corresponding action.
The graph structure enables complex business logic modeling with branching, parallel processing, and conditional execution paths.

---

## businessRules

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/business-rules

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve business rules with comprehensive filtering and pagination support.

Provides flexible search capabilities across business rule collections including filtering by type, creation dates, and modification timestamps.
Results are paginated for efficient data handling and include metadata for navigation and total count information.

Possible errors:

- BUSINESS_RULE_UNKNOWN_ERROR: Unexpected error occurred during search operation

```graphql
businessRules(
  filter: BusinessRuleSearchInput
): BusinessRuleResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>businessRules.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>BusinessRuleSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/business-rule-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Optional search criteria for filtering business rules by type, dates, and pagination settings.

When not provided, returns all accessible business rules with default pagination (page 1, 12 items per page).

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>BusinessRuleResponse</b></code>](/reference/legacy/graphql-v1/objects/business-rule-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response container for business rule search queries with metadata.

Provides structured access to business rule collections with pagination support,
including total count information and navigation metadata for efficient data browsing and API consumption.

---

## carrier

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/carrier

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve detailed information about a specific shipping carrier.

    Returns comprehensive carrier data including service type, localized descriptions, pricing information, tracking URL template, logo, and warehouse coverage. Used for shipping configuration, logistics management, and displaying carrier options to customers.

    Possible errors:
    - CARRIER&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Carrier with the specified ID does not exist in the system
    - CARRIER&#x005F;GET&#x005F;ERROR: Failed to retrieve carrier information due to data source connection issues or query execution failure

```graphql
carrier(
  id: Int!
): Carrier!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carrier.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the carrier to retrieve.

      Must be a positive integer representing a valid carrier ID in the system. This ID is used to reference the carrier throughout shipping operations and logistics management.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Carrier</b></code>](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary " text="object"/>

Shipping carrier configuration for logistics and delivery operations.

Represents a shipping company or service provider including service details, coverage areas, pricing information, and integration settings. Used for shipping calculations, order fulfillment, and logistics management.

---

## carriers

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/carriers

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve shipping carriers with comprehensive filtering and pagination.

    Provides flexible search capabilities across carrier data including names, service types, warehouse coverage, and operational status. Results are paginated and can be filtered based on various carrier criteria including creation dates, modification dates, and service types.

    Possible errors:
    - CARRIERS&#x005F;LIST&#x005F;ERROR: Failed to retrieve carriers from data source due to query execution failure or connection issues

```graphql
carriers(
  input: CarriersSearchInput
): CarriersResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>carriers.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CarriersSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering and paginating carriers.

      If not provided, returns all accessible carriers with default pagination settings (page 1, 12 items per page). Supports filtering by carrier names, service types, warehouse coverage, creation dates, and modification dates. Results can be sorted by multiple fields with custom ordering.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CarriersResponse</b></code>](/reference/legacy/graphql-v1/objects/carriers-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing carrier search results.

Provides a structured response for carrier search operations including the matching carriers, pagination metadata, and result statistics. Used to deliver carrier data with comprehensive pagination support.

---

## cart

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/cart

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cart(
  cartId: String!
): ICart!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cart.<b>cartId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ICart</b></code>](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary " text="interface"/>

---

## categories

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/categories

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
categories(
  filter: CategorySearchInput
  userId: Int
): CategoryResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>categories.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CategorySearchInput</b></code>](/reference/legacy/graphql-v1/inputs/category-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

#### [<code style={{ fontWeight: 'normal' }}>categories.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CategoryResponse</b></code>](/reference/legacy/graphql-v1/objects/category-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## category

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/category

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
category(
  id: Float
  categoryId: Float
  slug: String
  userId: Int
): Category!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>category.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use categoryId instead

#### [<code style={{ fontWeight: 'normal' }}>category.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>category.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>category.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Category</b></code>](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## channel

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/channel

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
channel(
  channelId: Int!
): Channel!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>channel.<b>channelId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Channel</b></code>](/reference/legacy/graphql-v1/objects/channel.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## channels

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/channels

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
channels: [Channel!]!
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Channel</b></code>](/reference/legacy/graphql-v1/objects/channel.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## cluster

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/cluster

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
cluster(
  id: Int
  clusterId: Int
  slug: String
  language: String
): Cluster!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>cluster.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use clusterId instead

#### [<code style={{ fontWeight: 'normal' }}>cluster.<b>clusterId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cluster.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>cluster.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language to search by slug

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Cluster</b></code>](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## companies

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/companies

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
companies(
  input: CompanySearchArguments
): CompaniesResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>companies.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CompanySearchArguments</b></code>](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CompaniesResponse</b></code>](/reference/legacy/graphql-v1/objects/companies-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## company

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/company

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
company(
  id: Float
  companyId: Float
): Company!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>company.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use companyId instead

#### [<code style={{ fontWeight: 'normal' }}>company.<b>companyId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Company</b></code>](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contactAttributeValues

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/contact-attribute-values

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
contactAttributeValues(
  contactId: Int!
  filter: AttributeFilterInput
): AttributeValueResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contactAttributeValues.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>contactAttributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contact

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/contact

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
contact(
  id: Float
  contactId: Float
): Contact!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contact.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use contactId instead

#### [<code style={{ fontWeight: 'normal' }}>contact.<b>contactId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Contact</b></code>](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## contacts

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/contacts

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
contacts(
  input: ContactSearchArguments
): ContactsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>contacts.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ContactSearchArguments</b></code>](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ContactsResponse</b></code>](/reference/legacy/graphql-v1/objects/contacts-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## crossupsells

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/crossupsells

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
crossupsells(
  input: CrossupsellInput!
): [Crossupsell!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>crossupsells.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CrossupsellInput!</b></code>](/reference/legacy/graphql-v1/inputs/crossupsell-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Crossupsell</b></code>](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customerAttributeValues

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/customer-attribute-values

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
customerAttributeValues(
  customerId: Int!
  filter: AttributeFilterInput
): AttributeValueResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customerAttributeValues.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>customerAttributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customer

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/customer

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
customer(
  id: Float
  customerId: Float
): Customer!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customer.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use customerId instead

#### [<code style={{ fontWeight: 'normal' }}>customer.<b>customerId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Customer</b></code>](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## customers

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/customers

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
customers(
  input: CustomerSearchArguments
): CustomersResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>customers.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>CustomerSearchArguments</b></code>](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>CustomersResponse</b></code>](/reference/legacy/graphql-v1/objects/customers-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## defaultPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/default-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Returns product(s) default price (without calculated discounts).

```graphql
defaultPrice(
  productIds: [Int!]!
  taxZone: String! = NL
): [ProductDefaultPrice!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>defaultPrice.<b>productIds</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Product unique identifiers. Can be array of productIds or single productId.

#### [<code style={{ fontWeight: 'normal' }}>defaultPrice.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

taxZone to be used for calculating net price of the product(s).

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ProductDefaultPrice</b></code>](/reference/legacy/graphql-v1/objects/product-default-price.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## explainPrice

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/explain-price

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
explainPrice(
  productId: Float!
  quantity: Float
  userId: Float
  taxZone: String! = NL
): [ProductPrice!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>explainPrice.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>explainPrice.<b>quantity</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>explainPrice.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>explainPrice.<b>taxZone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ProductPrice</b></code>](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## externalAddress

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/external-address

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER] OR ('user is authenticated')

```graphql
externalAddress(
  id: Float!
): ExternalAddress!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>externalAddress.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float!</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ExternalAddress</b></code>](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/favorite-list

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[system] OR ('user is authenticated')

```graphql
favoriteList(
  id: String!
): FavoriteList!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteList.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

ID must be valid string with length of 12 or 24 chars

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteList</b></code>](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## favoriteLists

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/favorite-lists

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Get favorite lists, use either an id or a source

```graphql
favoriteLists(
  input: FavoriteListsSearchInput
): FavoriteListsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>favoriteLists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>FavoriteListsSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>FavoriteListsResponse</b></code>](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## inventory

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/inventory

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[logistics.OWNER,logistics.EDITOR,logistics.VIEWER]

```graphql
inventory(
  id: Int!
): InventoryResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>inventory.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>InventoryResponse</b></code>](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## machine

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/machine

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Get a single SparePartsMachine, either by id, slug & language or by source & sourceId.

```graphql
machine(
  id: String
  slug: String
  language: String
  source: String
  sourceId: String
): SparePartsMachine
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>machine.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>machine.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>machine.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>machine.<b>source</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>machine.<b>sourceId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SparePartsMachine</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## machines

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/machines

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

List machines

```graphql
machines(
  input: SearchSparePartsMachineInput
): SparePartsMachineResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>machines.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SearchSparePartsMachineInput</b></code>](/reference/legacy/graphql-v1/inputs/search-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>SparePartsMachineResponse</b></code>](/reference/legacy/graphql-v1/objects/spare-parts-machine-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## media

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/media

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Access point for media management operations.

    Provides a unified interface for accessing different types of media content including images, videos, documents, and attachments. Use the nested resolvers to access specific media types.

    Note: This is a placeholder query that returns an empty Media object. Use the nested resolvers (image, images, video, videos, document, documents, attachment, attachments) to access actual media content.

```graphql
media: Media
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Media</b></code>](/reference/legacy/graphql-v1/objects/media.mdx) <Badge class="badge badge--secondary " text="object"/>

Unified media access point providing single items and paginated collections for all media types

---

## orderGetPDF

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/order-get-pdf

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderGetPDF(
  orderId: Int!
): Base64File!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderGetPDF.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Base64File</b></code>](/reference/legacy/graphql-v1/objects/base-64-file.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## order

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/order

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR ('user is authenticated')

```graphql
order(
  orderId: Int
  orderUUID: String
): Order!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>order.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>order.<b>orderUUID</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Order</b></code>](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/orderlist

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlist(
  id: Int!
): Orderlist!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlist.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Orderlist</b></code>](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orderlists

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/orderlists

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
orderlists(
  input: OrderlistSearchInput
): OrderlistsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orderlists.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderlistSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>OrderlistsResponse</b></code>](/reference/legacy/graphql-v1/objects/orderlists-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## orders

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/orders

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

```graphql
orders(
  input: OrderSearchArguments!
): OrderResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>orders.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>OrderSearchArguments!</b></code>](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>OrderResponse</b></code>](/reference/legacy/graphql-v1/objects/order-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## payMethod

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/pay-method

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve detailed information about a specific payment method.

    Returns comprehensive payment method data including localized names, external integration codes, branding elements, and configuration details. Used for payment processing workflows and checkout system integration.

    Possible errors:
    - PAY&#x005F;METHOD&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Payment method with the specified ID does not exist
    - PAY&#x005F;METHOD&#x005F;UNKNOWN&#x005F;ERROR: Unknown error occurred while retrieving payment method

```graphql
payMethod(
  id: Int!
): PayMethod!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payMethod.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the payment method to retrieve.

      Must be a positive integer representing a valid payment method ID in the system.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PayMethod</b></code>](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment method configuration for checkout and payment processing.

Represents a payment option available to customers during checkout including configuration details, branding, and integration settings. Used for payment processing, checkout flows, and financial transaction management.

---

## payMethods

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/pay-methods

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve payment methods with comprehensive filtering and pagination.

    Provides flexible search capabilities for payment method discovery including date range filtering, external code matching, and identifier-based searches. Results are paginated and support custom sorting for efficient payment method catalog management.

    Possible errors:
    - PAY&#x005F;METHOD&#x005F;UNKNOWN&#x005F;ERROR: Unknown error occurred while searching payment methods

```graphql
payMethods(
  input: PayMethodSearchInput
): PayMethodsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payMethods.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PayMethodSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/pay-method-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering payment methods.

      If not provided, returns all accessible payment methods with default pagination settings. Supports filtering by type, status, and configuration options.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PayMethodsResponse</b></code>](/reference/legacy/graphql-v1/objects/pay-methods-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing payment methods and pagination metadata.

Provides a structured response for payment method queries including the matching results and comprehensive pagination information for efficient data navigation.

---

## payment

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/payment

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve detailed information about a specific payment.

Returns comprehensive payment data including transaction details, payment status, and processing information. Used for payment tracking, order management, and financial reporting. Automatically includes transaction details for complete financial context.

Possible errors:

- GET_PAYMENT_ERROR: Failed to retrieve payment information due to system error
- PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
- FORBIDDEN: Insufficient permissions to access payment data

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

```graphql
payment(
  searchBy: SearchByInput!
): Payment
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payment.<b>searchBy</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>SearchByInput!</b></code>](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

Search criteria for finding the payment.

      Specifies how to identify the payment (by ID, payment ID, or order ID) for retrieval.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Payment</b></code>](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary " text="object"/>

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.

---

## payments

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/payments

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve payments with comprehensive filtering and pagination.

Provides flexible search capabilities across payment data with configurable pagination controls. Results include comprehensive payment information and transaction details by default for complete financial context. Supports response expansion options to optimize data retrieval.

Possible errors:

- LIST_PAYMENTS_ERROR: Failed to retrieve payments due to system error
- FORBIDDEN: Insufficient permissions to access payment data

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER]

```graphql
payments(
  input: PaymentsSearchInput
): PaymentsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>payments.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PaymentsSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/payments-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria for filtering payments.

      If not provided, returns all accessible payments with default pagination (12 items per page) and includes transaction details.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>PaymentsResponse</b></code>](/reference/legacy/graphql-v1/objects/payments-response.mdx) <Badge class="badge badge--secondary " text="object"/>

Paginated response containing payment records with navigation metadata.

Includes payment data along with pagination controls for efficient data browsing and client-side state management. Supports response expansion to include related transaction details.

---

## productAttributeValues

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/product-attribute-values

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
productAttributeValues(
  productId: Int!
  filter: AttributeFilterInput
): AttributeValueResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>productAttributeValues.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>productAttributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## product

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/product

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
product(
  id: Int
  productId: Int
  slug: String
  sku: String
  language: String
): Product!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>product.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use productId instead

#### [<code style={{ fontWeight: 'normal' }}>product.<b>productId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>product.<b>slug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>product.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>product.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Language to search by slug

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Product</b></code>](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## products

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/products

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
products(
  term: String
  manufacturer: [String!]
  supplierCode: [String!]
  supplier: [String!]
  manufacturerCode: [String!]
  EANCode: [String!]
  id: [Int!]
  classId: [Int!]
  class: ProductClass
  tag: [String!]
  language: String! = NL
  page: Int! = 1
  offset: Int! = 12
  textFilters: [TextFilterInput!]
  rangeFilters: [RangeFilterInput!]
  price: PriceFilterInput
  status: [ProductStatus!] = [A]
  hidden: Boolean
  sort: [SortInput!]
  searchFields: [SearchFieldsInput!]
  hasBundle: YesNo
  isBundleLeader: YesNo
  parentSlug: String
  pathSlug: String
  userId: Int
  path: String
  categoryId: Int
  sku: [String!]
  getDescendants: Boolean = true
): ProductsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>products.<b>term</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product search term

#### [<code style={{ fontWeight: 'normal' }}>products.<b>manufacturer</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturers

#### [<code style={{ fontWeight: 'normal' }}>products.<b>supplierCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product supplier codes

#### [<code style={{ fontWeight: 'normal' }}>products.<b>supplier</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product suppliers

#### [<code style={{ fontWeight: 'normal' }}>products.<b>manufacturerCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product manufacturer codes

#### [<code style={{ fontWeight: 'normal' }}>products.<b>EANCode</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product EAN codes

#### [<code style={{ fontWeight: 'normal' }}>products.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique product identifiers

#### [<code style={{ fontWeight: 'normal' }}>products.<b>classId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[Int!]</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of unique class identifier

#### [<code style={{ fontWeight: 'normal' }}>products.<b>class</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ProductClass</b></code>](/reference/legacy/graphql-v1/enums/product-class.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product class

#### [<code style={{ fontWeight: 'normal' }}>products.<b>tag</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product tags

#### [<code style={{ fontWeight: 'normal' }}>products.<b>language</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String!</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Specify through which language to search in, has no effect on other returned fields (eg. name,slug)

#### [<code style={{ fontWeight: 'normal' }}>products.<b>page</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination page number [default=1]

#### [<code style={{ fontWeight: 'normal' }}>products.<b>offset</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Pagination offset number [default=12][max: 500]

    NOTE: If offset &#x003E; 500 is supplied it will be capped to 500

#### [<code style={{ fontWeight: 'normal' }}>products.<b>textFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[TextFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of text filters

#### [<code style={{ fontWeight: 'normal' }}>products.<b>rangeFilters</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[RangeFilterInput!]</b></code>](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of range filters

#### [<code style={{ fontWeight: 'normal' }}>products.<b>price</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>PriceFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Product price filter

#### [<code style={{ fontWeight: 'normal' }}>products.<b>status</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[ProductStatus!]</b></code>](/reference/legacy/graphql-v1/enums/product-status.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="enum"/>

List of product status filters

#### [<code style={{ fontWeight: 'normal' }}>products.<b>hidden</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Is product hidden?

#### [<code style={{ fontWeight: 'normal' }}>products.<b>sort</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SortInput!]</b></code>](/reference/legacy/graphql-v1/inputs/sort-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

List of product sort filters

#### [<code style={{ fontWeight: 'normal' }}>products.<b>searchFields</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[SearchFieldsInput!]</b></code>](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="input"/>

Product supplier code

#### [<code style={{ fontWeight: 'normal' }}>products.<b>hasBundle</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

#### [<code style={{ fontWeight: 'normal' }}>products.<b>isBundleLeader</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>YesNo</b></code>](/reference/legacy/graphql-v1/enums/yes-no.mdx) <Badge class="badge badge--secondary " text="enum"/>

Product supplier code

#### [<code style={{ fontWeight: 'normal' }}>products.<b>parentSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product parent slug

#### [<code style={{ fontWeight: 'normal' }}>products.<b>pathSlug</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path slug

#### [<code style={{ fontWeight: 'normal' }}>products.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

#### [<code style={{ fontWeight: 'normal' }}>products.<b>path</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product path

#### [<code style={{ fontWeight: 'normal' }}>products.<b>categoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Product unique category identifier

#### [<code style={{ fontWeight: 'normal' }}>products.<b>sku</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>[String!]</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="list"/> <Badge class="badge badge--secondary " text="scalar"/>

List of product SKUs

#### [<code style={{ fontWeight: 'normal' }}>products.<b>getDescendants</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Boolean</b></code>](/reference/legacy/graphql-v1/scalars/boolean.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ProductsResponse</b></code>](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## shop

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/shop

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

```graphql
shop(
  shopId: Int!
): Shop!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>shop.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Shop</b></code>](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## shops

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/shops

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

AUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

```graphql
shops: [Shop!]!
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Shop</b></code>](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tax

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/tax

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tax(
  id: ID
  code: String
  zone: String
  shopId: Int
): Tax!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tax.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ID</b></code>](/reference/legacy/graphql-v1/scalars/id.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>tax.<b>code</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>tax.<b>zone</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>tax.<b>shopId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Shop identifier to filter by. Only used in combination with code and zone

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tax</b></code>](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## taxes

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/taxes

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
taxes(
  input: TaxSearchInput
): TaxesResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>taxes.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>TaxSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/tax-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>TaxesResponse</b></code>](/reference/legacy/graphql-v1/objects/taxes-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## tender

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/tender

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
tender(
  tenderId: String
  orderId: Int
): Tender!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>tender.<b>tenderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>tender.<b>orderId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Tender</b></code>](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userAclList

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/user-acl-list

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
userAclList(
  userId: Int!
  permission: Permission!
): [Int!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAclList.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>userAclList.<b>permission</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Permission!</b></code>](/reference/legacy/graphql-v1/enums/permission.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

---

## userAttributeValues

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/user-attribute-values

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
userAttributeValues(
  userId: Int!
  filter: AttributeFilterInput
): AttributeValueResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userAttributeValues.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>userAttributeValues.<b>filter</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>AttributeFilterInput</b></code>](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>AttributeValueResponse</b></code>](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## userDiscounts

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/user-discounts

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
userDiscounts(
  userId: Int
  userDirectoryId: Int
): [Discount!]!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>userDiscounts.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>userDiscounts.<b>userDirectoryId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Discount</b></code>](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## user

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/user

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
user(
  id: Float
  userId: Float
  login: String
): IBaseUser!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>user.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use userId instead

#### [<code style={{ fontWeight: 'normal' }}>user.<b>userId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

#### [<code style={{ fontWeight: 'normal' }}>user.<b>login</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>String</b></code>](/reference/legacy/graphql-v1/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

---

## usergroup

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/usergroup

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
usergroup(
  id: Float
  usergroupId: Float
): Usergroup!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>usergroup.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

Deprecated! use usergroupId instead

#### [<code style={{ fontWeight: 'normal' }}>usergroup.<b>usergroupId</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Float</b></code>](/reference/legacy/graphql-v1/scalars/float.mdx) <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Usergroup</b></code>](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## usergroups

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/usergroups

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
usergroups(
  input: UsergroupSearchArguments!
): UsergroupsResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>usergroups.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>UsergroupSearchArguments!</b></code>](/reference/legacy/graphql-v1/inputs/usergroup-search-arguments.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>UsergroupsResponse</b></code>](/reference/legacy/graphql-v1/objects/usergroups-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesetItems

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/valueset-items

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve value set items with comprehensive filtering and pagination.

    Provides flexible search capabilities across value set items including values, parent value sets, and additional metadata. Results are paginated and can be filtered for dropdown population and configuration management.

    Use this query to:
    • Retrieve items from specific value sets for dropdown lists
    • Search for items by their values or extra metadata
    • Implement pagination for large item collections
    • Filter items across multiple value sets

    Possible errors:
    - VALUESET&#x005F;ITEM&#x005F;LIST&#x005F;ERROR: Failed to retrieve value set items due to system error

```graphql
valuesetItems(
  input: ValuesetItemSearchInput
): ValuesetItemResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesetItems.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetItemSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/valueset-item-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria and pagination parameters for filtering value set items.

      Supports comprehensive filtering by parent value sets, item values, extra metadata, and identifiers. All parameters are optional, allowing flexible querying from broad searches to specific lookups.

      Pagination controls help manage large datasets efficiently across multiple value sets.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ValuesetItemResponse</b></code>](/reference/legacy/graphql-v1/objects/valueset-item-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valueset

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/valueset

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Retrieve detailed information about a specific value set.

    Returns comprehensive value set data including items, configuration, and metadata. Used for dropdown lists, configuration options, and data validation throughout the system.

    Possible errors:
    - VALUESET&#x005F;NOT&#x005F;FOUND&#x005F;ERROR: Value set with the specified ID does not exist
    - VALUESET&#x005F;GET&#x005F;ERROR: Failed to retrieve value set information

```graphql
valueset(
  id: Int!
): Valueset!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valueset.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

Unique identifier of the value set to retrieve.

      Must be a positive integer representing a valid value set ID in the system.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Valueset</b></code>](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## valuesets

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/valuesets

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

Search and retrieve value sets with comprehensive filtering and pagination.

    Provides flexible search capabilities across value set data including names, types, and configuration settings. Results are paginated and can be filtered for configuration management and dropdown population.

    Use this query to:
    • Browse available value sets for system configuration
    • Search for specific value sets by name or type
    • Filter value sets by creation or modification dates
    • Implement pagination for large result sets

    Possible errors:
    - VALUESET&#x005F;LIST&#x005F;ERROR: Failed to retrieve value sets due to system error

```graphql
valuesets(
  input: ValuesetSearchInput
): ValuesetResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>valuesets.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>ValuesetSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

Search criteria and pagination parameters for filtering value sets.

      Supports comprehensive filtering by names, types, creation dates, modification dates, and identifiers. All parameters are optional, allowing flexible querying from broad searches to specific lookups.

      Pagination controls help manage large datasets efficiently.

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>ValuesetResponse</b></code>](/reference/legacy/graphql-v1/objects/valueset-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## viewer

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/viewer

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
viewer: IBaseUser!
```

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>IBaseUser</b></code>](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary " text="interface"/>

Interface for the BaseUser Type, where both Contacts and Customers derive from

---

## warehouse

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/warehouse

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
warehouse(
  id: Int!
): Warehouse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouse.<b>id</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>Int!</b></code>](/reference/legacy/graphql-v1/scalars/int.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>Warehouse</b></code>](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## warehouses

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/queries/warehouses

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

No description

```graphql
warehouses(
  input: WarehousesSearchInput
): WarehousesResponse!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>warehouses.<b>input</b></code>](#)<Bullet />[<code style={{ fontWeight: 'normal' }}><b>WarehousesSearchInput</b></code>](/reference/legacy/graphql-v1/inputs/warehouses-search-input.mdx) <Badge class="badge badge--secondary " text="input"/>

### Type

#### [<code style={{ fontWeight: 'normal' }}><b>WarehousesResponse</b></code>](/reference/legacy/graphql-v1/objects/warehouses-response.mdx) <Badge class="badge badge--secondary " text="object"/>

---

## Boolean

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/boolean

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `Boolean` scalar type represents `true` or `false`.

```graphql
scalar Boolean
```

### Returned By

[`authenticationDelete`](/reference/legacy/graphql-v1/mutations/authentication-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`bundleDelete`](/reference/legacy/graphql-v1/mutations/bundle-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`bundleRemoveItem`](/reference/legacy/graphql-v1/mutations/bundle-remove-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`businessRuleDelete`](/reference/legacy/graphql-v1/mutations/business-rule-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierAssignWarehouse`](/reference/legacy/graphql-v1/deprecated/mutations/carrier-assign-warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierDelete`](/reference/legacy/graphql-v1/mutations/carrier-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierUnassignWarehouse`](/reference/legacy/graphql-v1/deprecated/mutations/carrier-unassign-warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`categoryDelete`](/reference/legacy/graphql-v1/mutations/category-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`channelInvalidateCache`](/reference/legacy/graphql-v1/mutations/channel-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`claimsReset`](/reference/legacy/graphql-v1/mutations/claims-reset.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`companyAddressDelete`](/reference/legacy/graphql-v1/mutations/company-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`contactDelete`](/reference/legacy/graphql-v1/mutations/contact-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`customerAddressDelete`](/reference/legacy/graphql-v1/mutations/customer-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`customerDelete`](/reference/legacy/graphql-v1/mutations/customer-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`discountInvalidateCache`](/reference/legacy/graphql-v1/mutations/discount-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`externalAddressDelete`](/reference/legacy/graphql-v1/mutations/external-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListDelete`](/reference/legacy/graphql-v1/mutations/favorite-list-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`machineDelete`](/reference/legacy/graphql-v1/mutations/machine-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderDelete`](/reference/legacy/graphql-v1/mutations/order-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderItemDelete`](/reference/legacy/graphql-v1/mutations/order-item-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistDelete`](/reference/legacy/graphql-v1/mutations/orderlist-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderUpdateAddress`](/reference/legacy/graphql-v1/mutations/order-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`payMethodDelete`](/reference/legacy/graphql-v1/mutations/pay-method-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`permissionsInvalidateCache`](/reference/legacy/graphql-v1/mutations/permissions-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`productDelete`](/reference/legacy/graphql-v1/mutations/product-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`shopInvalidateCache`](/reference/legacy/graphql-v1/mutations/shop-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userAddressDelete`](/reference/legacy/graphql-v1/mutations/user-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userDelete`](/reference/legacy/graphql-v1/mutations/user-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`usergroupDelete`](/reference/legacy/graphql-v1/mutations/usergroup-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`valuesetDelete`](/reference/legacy/graphql-v1/mutations/valueset-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`valuesetItemDelete`](/reference/legacy/graphql-v1/mutations/valueset-item-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseAddressDelete`](/reference/legacy/graphql-v1/mutations/warehouse-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescription`](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescriptionSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-description-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeFilterInput`](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeTextFilter`](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleFieldDefinitionGroup`](/reference/legacy/graphql-v1/objects/business-rule-field-definition-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartDeleteResponse`](/reference/legacy/graphql-v1/objects/cart-delete-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartResponseData`](/reference/legacy/graphql-v1/objects/cart-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CompanySearchArguments`](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CreateWarehouseInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`favoriteListClearItems`](/reference/legacy/graphql-v1/mutations/favorite-list-clear-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`FavoriteListsBaseSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsCreateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsUpdateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FilterAvailableAttributeInput`](/reference/legacy/graphql-v1/inputs/filter-available-attribute-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`GCIPUser`](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IAttributeTextFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterOption`](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`include`](/reference/legacy/graphql-v1/directives/include.mdx) <Badge class="badge badge--secondary badge--relation" text="directive"/><Bullet />[`OrderSetStatusInput`](/reference/legacy/graphql-v1/inputs/order-set-status-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`PublishEmailEventResponse`](/reference/legacy/graphql-v1/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RangeFilterInput`](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserInput`](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SendOrderConfirmResponseType`](/reference/legacy/graphql-v1/objects/send-order-confirm-response-type.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Shop`](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ShopPriceCalculationConfig`](/reference/legacy/graphql-v1/objects/shop-price-calculation-config.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`skip`](/reference/legacy/graphql-v1/directives/skip.mdx) <Badge class="badge badge--secondary badge--relation" text="directive"/><Bullet />[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderAddItemsInput`](/reference/legacy/graphql-v1/inputs/tender-add-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderPayment`](/reference/legacy/graphql-v1/objects/tender-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPaymethod`](/reference/legacy/graphql-v1/objects/tender-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostageInput`](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderResponseData`](/reference/legacy/graphql-v1/objects/tender-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderTotal`](/reference/legacy/graphql-v1/objects/tender-total.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderUpdateItemInput`](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TextFilterInput`](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`VerifyToken`](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehousesSearchInput`](/reference/legacy/graphql-v1/inputs/warehouses-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## DateTime

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/date-time

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

```graphql
scalar DateTime
```

### Member Of

[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageDataInput`](/reference/legacy/graphql-v1/inputs/cart-postage-data-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CreateTransactionInput`](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Discount`](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`GCIPUser`](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Inventory`](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IProductOffer`](/reference/legacy/graphql-v1/interfaces/iproduct-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPaymentData`](/reference/legacy/graphql-v1/objects/order-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPaymentInput`](/reference/legacy/graphql-v1/inputs/order-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentUpdateInput`](/reference/legacy/graphql-v1/inputs/order-payment-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageInput`](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageUpdateInput`](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PayMethod`](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductInventory`](/reference/legacy/graphql-v1/objects/product-inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductOffer`](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterUserSession`](/reference/legacy/graphql-v1/objects/register-user-session.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderAddItemInput`](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderChildItemInput`](/reference/legacy/graphql-v1/inputs/tender-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPayment`](/reference/legacy/graphql-v1/objects/tender-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostageInput`](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderUpdateItemInput`](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Float

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/float

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).

```graphql
scalar Float
```

### Member Of

[`addressesByCompanyId`](/reference/legacy/graphql-v1/queries/addresses-by-company-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByCustomerId`](/reference/legacy/graphql-v1/queries/addresses-by-customer-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByOrderId`](/reference/legacy/graphql-v1/queries/addresses-by-order-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`addressesByUserId`](/reference/legacy/graphql-v1/queries/addresses-by-user-id.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDecimalRangeFilter`](/reference/legacy/graphql-v1/objects/attribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BulkPrice`](/reference/legacy/graphql-v1/objects/bulk-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`bulkPrice`](/reference/legacy/graphql-v1/queries/bulk-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`bundle`](/reference/legacy/graphql-v1/queries/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BundlePrice`](/reference/legacy/graphql-v1/objects/bundle-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`bundles`](/reference/legacy/graphql-v1/queries/bundles.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BusinessHours`](/reference/legacy/graphql-v1/objects/business-hours.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessHoursInput`](/reference/legacy/graphql-v1/inputs/business-hours-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleArrayExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-array-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableCell`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableSetCellInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleNumberExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-number-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CarrierUpdateInput`](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartAddItemInput`](/reference/legacy/graphql-v1/inputs/cart-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartCarrier`](/reference/legacy/graphql-v1/objects/cart-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartChildItemInput`](/reference/legacy/graphql-v1/inputs/cart-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartItemSurcharge`](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPaymentData`](/reference/legacy/graphql-v1/objects/cart-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPaymethod`](/reference/legacy/graphql-v1/objects/cart-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageDataInput`](/reference/legacy/graphql-v1/inputs/cart-postage-data-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartTaxLevel`](/reference/legacy/graphql-v1/objects/cart-tax-level.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartTotal`](/reference/legacy/graphql-v1/objects/cart-total.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartUpdateItemInput`](/reference/legacy/graphql-v1/inputs/cart-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateItemsInput`](/reference/legacy/graphql-v1/inputs/cart-update-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartVoucher`](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`category`](/reference/legacy/graphql-v1/queries/category.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`categoryDelete`](/reference/legacy/graphql-v1/mutations/category-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`categoryUpdate`](/reference/legacy/graphql-v1/mutations/category-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`company`](/reference/legacy/graphql-v1/queries/company.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`contact`](/reference/legacy/graphql-v1/queries/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`CreateBundleInput`](/reference/legacy/graphql-v1/inputs/create-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateInventoryInput`](/reference/legacy/graphql-v1/inputs/create-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateTaxInput`](/reference/legacy/graphql-v1/inputs/create-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`customer`](/reference/legacy/graphql-v1/queries/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`DecimalSearchInput`](/reference/legacy/graphql-v1/inputs/decimal-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Discount`](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`explainPrice`](/reference/legacy/graphql-v1/queries/explain-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`externalAddress`](/reference/legacy/graphql-v1/queries/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`IAttributeDecimalRangeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-decimal-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundle`](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundlePrice`](/reference/legacy/graphql-v1/interfaces/ibundle-price.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IncentiveRuleOrderItemSetCellInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Inventory`](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IProductOffer`](/reference/legacy/graphql-v1/interfaces/iproduct-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItemUpdateInput`](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentData`](/reference/legacy/graphql-v1/objects/order-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPaymentInput`](/reference/legacy/graphql-v1/inputs/order-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentUpdateInput`](/reference/legacy/graphql-v1/inputs/order-payment-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageInput`](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageUpdateInput`](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderTotalInput`](/reference/legacy/graphql-v1/inputs/order-total-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderTotals`](/reference/legacy/graphql-v1/objects/order-totals.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderTotalTaxPercentage`](/reference/legacy/graphql-v1/objects/order-total-tax-percentage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderTotalUpdateInput`](/reference/legacy/graphql-v1/inputs/order-total-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PriceFilterInput`](/reference/legacy/graphql-v1/inputs/price-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductDefaultPrice`](/reference/legacy/graphql-v1/objects/product-default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductOffer`](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductPrice`](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RangeFilterInput`](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SearchByInput`](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SharpenInput`](/reference/legacy/graphql-v1/inputs/sharpen-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ShipmentItem`](/reference/legacy/graphql-v1/objects/shipment-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Surcharge`](/reference/legacy/graphql-v1/objects/surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tax`](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderAddItemInput`](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderCarrier`](/reference/legacy/graphql-v1/objects/tender-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderChildItemInput`](/reference/legacy/graphql-v1/inputs/tender-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderDiscountInput`](/reference/legacy/graphql-v1/inputs/tender-discount-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPayment`](/reference/legacy/graphql-v1/objects/tender-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPaymentInput`](/reference/legacy/graphql-v1/inputs/tender-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderPaymethod`](/reference/legacy/graphql-v1/objects/tender-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostageInput`](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderTaxLevel`](/reference/legacy/graphql-v1/objects/tender-tax-level.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderTotal`](/reference/legacy/graphql-v1/objects/tender-total.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderUpdateItemInput`](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateBundleInput`](/reference/legacy/graphql-v1/inputs/update-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateInventoryInput`](/reference/legacy/graphql-v1/inputs/update-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateTaxInput`](/reference/legacy/graphql-v1/inputs/update-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`user`](/reference/legacy/graphql-v1/queries/user.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`usergroup`](/reference/legacy/graphql-v1/queries/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`UserManagementAttributeSearchInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeValueInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItemResponse`](/reference/legacy/graphql-v1/objects/valueset-item-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetResponse`](/reference/legacy/graphql-v1/objects/valueset-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`warehouseAddressCreate`](/reference/legacy/graphql-v1/mutations/warehouse-address-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseAddressDelete`](/reference/legacy/graphql-v1/mutations/warehouse-address-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseAddressUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-address-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseDelete`](/reference/legacy/graphql-v1/mutations/warehouse-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`warehouseUpdate`](/reference/legacy/graphql-v1/mutations/warehouse-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

---

## ID

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/id

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

```graphql
scalar ID
```

### Member Of

[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`businessRule`](/reference/legacy/graphql-v1/queries/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTable`](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableAddColumnInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-add-column-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableCell`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableDeleteColumnInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-column-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableDeleteRowInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-delete-row-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableInputOutput`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-input-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableMoveRowInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-move-row-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableRow`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-row.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableSearchInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableSetCellInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableUpdateInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`businessRuleDelete`](/reference/legacy/graphql-v1/mutations/business-rule-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`BusinessRuleEdge`](/reference/legacy/graphql-v1/objects/business-rule-edge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinitionGroup`](/reference/legacy/graphql-v1/objects/business-rule-field-definition-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleInput`](/reference/legacy/graphql-v1/objects/business-rule-input.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`businessRuleJDM`](/reference/legacy/graphql-v1/queries/business-rule-jdm.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleOutput`](/reference/legacy/graphql-v1/objects/business-rule-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpression`](/reference/legacy/graphql-v1/objects/business-rule-string-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleSubExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`businessRuleUpdate`](/reference/legacy/graphql-v1/mutations/business-rule-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IBusinessRuleExpression`](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBusinessRuleNode`](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IncentiveRuleOrderItemSetCellInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Inventory`](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaDocumentInput`](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaImageInput`](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaVideoInput`](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SearchByInput`](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SparePart`](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachine`](/reference/legacy/graphql-v1/objects/spare-parts-machine.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tax`](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tax`](/reference/legacy/graphql-v1/queries/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`taxDelete`](/reference/legacy/graphql-v1/mutations/tax-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`taxUpdate`](/reference/legacy/graphql-v1/mutations/tax-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Int

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/int

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

```graphql
scalar Int
```

### Returned By

[`attributeClassIdsByNameAndValue`](/reference/legacy/graphql-v1/queries/attribute-class-ids-by-name-and-value.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAclList`](/reference/legacy/graphql-v1/queries/user-acl-list.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`Ace`](/reference/legacy/graphql-v1/objects/ace.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`addCompanyManager`](/reference/legacy/graphql-v1/mutations/add-company-manager.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Address`](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescription`](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescriptionResponse`](/reference/legacy/graphql-v1/objects/attribute-description-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescriptionSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-description-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeFilterInput`](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeIntegerRangeFilter`](/reference/legacy/graphql-v1/objects/attribute-integer-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeTextFilter`](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeValueResponse`](/reference/legacy/graphql-v1/objects/attribute-value-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BulkPrice`](/reference/legacy/graphql-v1/objects/bulk-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`bundleAddItems`](/reference/legacy/graphql-v1/mutations/bundle-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`bundleDelete`](/reference/legacy/graphql-v1/mutations/bundle-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`BundleItem`](/reference/legacy/graphql-v1/objects/bundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BundleItemInput`](/reference/legacy/graphql-v1/inputs/bundle-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`bundleRemoveItem`](/reference/legacy/graphql-v1/mutations/bundle-remove-item.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`BundleSearchInput`](/reference/legacy/graphql-v1/inputs/bundle-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`bundleUpdate`](/reference/legacy/graphql-v1/mutations/bundle-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleResponse`](/reference/legacy/graphql-v1/objects/business-rule-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleSearchInput`](/reference/legacy/graphql-v1/inputs/business-rule-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CacheControlInput`](/reference/legacy/graphql-v1/inputs/cache-control-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CanvasInput`](/reference/legacy/graphql-v1/inputs/canvas-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`carrier`](/reference/legacy/graphql-v1/queries/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`carrierAssignWarehouse`](/reference/legacy/graphql-v1/deprecated/mutations/carrier-assign-warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierAssignWarehouseAndReturnCarrier`](/reference/legacy/graphql-v1/mutations/carrier-assign-warehouse-and-return-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CarrierCreateInput`](/reference/legacy/graphql-v1/inputs/carrier-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`carrierDelete`](/reference/legacy/graphql-v1/mutations/carrier-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CarriersResponse`](/reference/legacy/graphql-v1/objects/carriers-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CarriersSearchInput`](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`carrierUnassignWarehouse`](/reference/legacy/graphql-v1/deprecated/mutations/carrier-unassign-warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierUnassignWarehouseAndReturnCarrier`](/reference/legacy/graphql-v1/mutations/carrier-unassign-warehouse-and-return-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`carrierUpdate`](/reference/legacy/graphql-v1/mutations/carrier-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CarrierUpdateInput`](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartAddBundleInput`](/reference/legacy/graphql-v1/inputs/cart-add-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartAddItemInput`](/reference/legacy/graphql-v1/inputs/cart-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartChildItemInput`](/reference/legacy/graphql-v1/inputs/cart-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartDeleteItemInput`](/reference/legacy/graphql-v1/inputs/cart-delete-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartIncentive`](/reference/legacy/graphql-v1/objects/cart-incentive.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartItemSurcharge`](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartProcessResponse`](/reference/legacy/graphql-v1/objects/cart-process-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartSetUserInput`](/reference/legacy/graphql-v1/inputs/cart-set-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`cartStart`](/reference/legacy/graphql-v1/mutations/cart-start.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartUpdateItemInput`](/reference/legacy/graphql-v1/inputs/cart-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateItemsInput`](/reference/legacy/graphql-v1/inputs/cart-update-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartVoucher`](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`categories`](/reference/legacy/graphql-v1/queries/categories.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`category`](/reference/legacy/graphql-v1/queries/category.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`CategoryResponse`](/reference/legacy/graphql-v1/objects/category-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CategorySearchInput`](/reference/legacy/graphql-v1/inputs/category-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Channel`](/reference/legacy/graphql-v1/objects/channel.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`channel`](/reference/legacy/graphql-v1/queries/channel.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`cluster`](/reference/legacy/graphql-v1/queries/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ClusterDrillDown`](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ClusterOption`](/reference/legacy/graphql-v1/objects/cluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CompaniesResponse`](/reference/legacy/graphql-v1/objects/companies-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CompanyAddressCreateInput`](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressDeleteInput`](/reference/legacy/graphql-v1/inputs/company-address-delete-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/company-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`companyDelete`](/reference/legacy/graphql-v1/mutations/company-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CompanySearchArguments`](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`contactAttributeValues`](/reference/legacy/graphql-v1/queries/contact-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`contactDelete`](/reference/legacy/graphql-v1/mutations/contact-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ContactsResponse`](/reference/legacy/graphql-v1/objects/contacts-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CreateCategoryInput`](/reference/legacy/graphql-v1/inputs/create-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateCompanyInput`](/reference/legacy/graphql-v1/inputs/create-company-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateContactInput`](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateInventoryInput`](/reference/legacy/graphql-v1/inputs/create-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreatePaymentInput`](/reference/legacy/graphql-v1/inputs/create-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateSparePartInput`](/reference/legacy/graphql-v1/inputs/create-spare-part-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateTaxInput`](/reference/legacy/graphql-v1/inputs/create-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateTransactionInput`](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUsergroupInput`](/reference/legacy/graphql-v1/inputs/create-usergroup-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUserInput`](/reference/legacy/graphql-v1/inputs/create-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateWarehouseInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CropInput`](/reference/legacy/graphql-v1/inputs/crop-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Crossupsell`](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CrossupsellInput`](/reference/legacy/graphql-v1/inputs/crossupsell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CsvImportResponse`](/reference/legacy/graphql-v1/objects/csv-import-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CsvRecordError`](/reference/legacy/graphql-v1/objects/csv-record-error.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CustomerAddressCreateInput`](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressDeleteInput`](/reference/legacy/graphql-v1/inputs/customer-address-delete-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/customer-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`customerAttributeValues`](/reference/legacy/graphql-v1/queries/customer-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`customerDelete`](/reference/legacy/graphql-v1/mutations/customer-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CustomerInput`](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomersResponse`](/reference/legacy/graphql-v1/objects/customers-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`defaultPrice`](/reference/legacy/graphql-v1/queries/default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`DeleteWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/delete-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Discount`](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`discountInvalidateCache`](/reference/legacy/graphql-v1/mutations/discount-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddress`](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ExternalAddressDeleteInput`](/reference/legacy/graphql-v1/inputs/external-address-delete-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/external-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`FavoriteListsBaseSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsCreateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsItemsInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsResponse`](/reference/legacy/graphql-v1/objects/favorite-lists-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`FavoriteListsSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsUpdateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IAttributeIntegerRangeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-integer-range-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IAttributeTextFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseProduct`](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundleItem`](/reference/legacy/graphql-v1/interfaces/ibundle-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterDrillDown`](/reference/legacy/graphql-v1/interfaces/icluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterOption`](/reference/legacy/graphql-v1/interfaces/icluster-option.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Inventory`](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`inventory`](/reference/legacy/graphql-v1/queries/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`inventoryDelete`](/reference/legacy/graphql-v1/mutations/inventory-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`inventoryUpdate`](/reference/legacy/graphql-v1/mutations/inventory-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IResource`](/reference/legacy/graphql-v1/interfaces/iresource.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`logout`](/reference/legacy/graphql-v1/deprecated/mutations/logout.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaAttachmentSearchInput`](/reference/legacy/graphql-v1/inputs/media-attachment-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaDocumentInput`](/reference/legacy/graphql-v1/inputs/media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaDocumentSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaImageInput`](/reference/legacy/graphql-v1/inputs/media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaImageSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`MediaVideoInput`](/reference/legacy/graphql-v1/inputs/media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoProductSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-product-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaVideoSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ObjectMediaSearchInput`](/reference/legacy/graphql-v1/inputs/object-media-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`order`](/reference/legacy/graphql-v1/queries/order.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderDelete`](/reference/legacy/graphql-v1/mutations/order-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderGetPDF`](/reference/legacy/graphql-v1/queries/order-get-pdf.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`orderItemCreate`](/reference/legacy/graphql-v1/mutations/order-item-create.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderItemDelete`](/reference/legacy/graphql-v1/mutations/order-item-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderItemUpdate`](/reference/legacy/graphql-v1/mutations/order-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderItemUpdateInput`](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Orderlist`](/reference/legacy/graphql-v1/objects/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`orderlist`](/reference/legacy/graphql-v1/queries/orderlist.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderlistAddItems`](/reference/legacy/graphql-v1/mutations/orderlist-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistAssignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-assign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistAssignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-assign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderlistCompaniesInput`](/reference/legacy/graphql-v1/inputs/orderlist-companies-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistCreateInput`](/reference/legacy/graphql-v1/inputs/orderlist-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderlistDelete`](/reference/legacy/graphql-v1/mutations/orderlist-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderlistItemsInput`](/reference/legacy/graphql-v1/inputs/orderlist-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderlistRemoveItems`](/reference/legacy/graphql-v1/mutations/orderlist-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderlistSearchInput`](/reference/legacy/graphql-v1/inputs/orderlist-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistsResponse`](/reference/legacy/graphql-v1/objects/orderlists-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`orderlistUnassignCompanies`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-companies.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUnassignUsers`](/reference/legacy/graphql-v1/mutations/orderlist-unassign-users.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderlistUpdate`](/reference/legacy/graphql-v1/mutations/orderlist-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderlistUpdateInput`](/reference/legacy/graphql-v1/inputs/orderlist-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderlistUsersInput`](/reference/legacy/graphql-v1/inputs/orderlist-users-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageInput`](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageUpdateInput`](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderResponse`](/reference/legacy/graphql-v1/objects/order-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/deprecated/queries/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`orderSendConfirmationEmail`](/reference/legacy/graphql-v1/mutations/order-send-confirmation-email.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderSetStatusInput`](/reference/legacy/graphql-v1/inputs/order-set-status-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderTotals`](/reference/legacy/graphql-v1/objects/order-totals.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderTotalTaxPercentage`](/reference/legacy/graphql-v1/objects/order-total-tax-percentage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`orderUpdate`](/reference/legacy/graphql-v1/mutations/order-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`orderUpdateAddress`](/reference/legacy/graphql-v1/mutations/order-update-address.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PadInput`](/reference/legacy/graphql-v1/inputs/pad-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PaginatedMediaAttachmentResponse`](/reference/legacy/graphql-v1/objects/paginated-media-attachment-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaDocumentResponse`](/reference/legacy/graphql-v1/objects/paginated-media-document-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaImageResponse`](/reference/legacy/graphql-v1/objects/paginated-media-image-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaginatedMediaVideoResponse`](/reference/legacy/graphql-v1/objects/paginated-media-video-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaymentsResponse`](/reference/legacy/graphql-v1/objects/payments-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PaymentsSearchInput`](/reference/legacy/graphql-v1/inputs/payments-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethod`](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`payMethod`](/reference/legacy/graphql-v1/queries/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`payMethodDelete`](/reference/legacy/graphql-v1/mutations/pay-method-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`PayMethodSearchInput`](/reference/legacy/graphql-v1/inputs/pay-method-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodsResponse`](/reference/legacy/graphql-v1/objects/pay-methods-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`payMethodUpdate`](/reference/legacy/graphql-v1/mutations/pay-method-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`permissionsInvalidateCache`](/reference/legacy/graphql-v1/mutations/permissions-invalidate-cache.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`product`](/reference/legacy/graphql-v1/queries/product.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productAttributes`](/reference/legacy/graphql-v1/deprecated/queries/product-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`productAttributeValues`](/reference/legacy/graphql-v1/queries/product-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ProductDefaultPrice`](/reference/legacy/graphql-v1/objects/product-default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`productDelete`](/reference/legacy/graphql-v1/mutations/product-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`ProductInventory`](/reference/legacy/graphql-v1/objects/product-inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductPrice`](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ProductsResponse`](/reference/legacy/graphql-v1/objects/products-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RefreshTokenResponse`](/reference/legacy/graphql-v1/objects/refresh-token-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterContactInput`](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterCustomerInput`](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserInput`](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`removeCompanyManager`](/reference/legacy/graphql-v1/mutations/remove-company-manager.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`SearchFieldsInput`](/reference/legacy/graphql-v1/inputs/search-fields-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SearchSparePartsMachineInput`](/reference/legacy/graphql-v1/inputs/search-spare-parts-machine-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SharpenInput`](/reference/legacy/graphql-v1/inputs/sharpen-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ShipmentItem`](/reference/legacy/graphql-v1/objects/shipment-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Shop`](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`shop`](/reference/legacy/graphql-v1/queries/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`site`](/reference/legacy/graphql-v1/deprecated/queries/site.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Site`](/reference/legacy/graphql-v1/objects/site.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePart`](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsMachineResponse`](/reference/legacy/graphql-v1/objects/spare-parts-machine-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SparePartsResponse`](/reference/legacy/graphql-v1/objects/spare-parts-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`startSession`](/reference/legacy/graphql-v1/mutations/start-session.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Surcharge`](/reference/legacy/graphql-v1/objects/surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tax`](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tax`](/reference/legacy/graphql-v1/queries/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`TaxesResponse`](/reference/legacy/graphql-v1/objects/taxes-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TaxSearchInput`](/reference/legacy/graphql-v1/inputs/tax-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tender`](/reference/legacy/graphql-v1/queries/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`TenderAddItemInput`](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderChildItemInput`](/reference/legacy/graphql-v1/inputs/tender-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderDeleteItemInput`](/reference/legacy/graphql-v1/inputs/tender-delete-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostageInput`](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderProcessResponse`](/reference/legacy/graphql-v1/objects/tender-process-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderStart`](/reference/legacy/graphql-v1/inputs/tender-start.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`tenderUpdateInvoiceUser`](/reference/legacy/graphql-v1/mutations/tender-update-invoice-user.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`TenderUpdateItemInput`](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TrackAndTrace`](/reference/legacy/graphql-v1/objects/track-and-trace.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TrimInput`](/reference/legacy/graphql-v1/inputs/trim-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCategoryInput`](/reference/legacy/graphql-v1/inputs/update-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCompanyInput`](/reference/legacy/graphql-v1/inputs/update-company-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateContactInput`](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCustomerInput`](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateInventoryInput`](/reference/legacy/graphql-v1/inputs/update-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaAttachmentInput`](/reference/legacy/graphql-v1/inputs/update-media-attachment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdatePaymentInput`](/reference/legacy/graphql-v1/inputs/update-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateTaxInput`](/reference/legacy/graphql-v1/inputs/update-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUsergroupInput`](/reference/legacy/graphql-v1/inputs/update-usergroup-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUserInput`](/reference/legacy/graphql-v1/inputs/update-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`userAclList`](/reference/legacy/graphql-v1/queries/user-acl-list.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`UserAddressCreateInput`](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressDeleteInput`](/reference/legacy/graphql-v1/inputs/user-address-delete-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/user-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`userAttributes`](/reference/legacy/graphql-v1/deprecated/queries/user-attributes.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`userAttributeValues`](/reference/legacy/graphql-v1/queries/user-attribute-values.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`UserClaims`](/reference/legacy/graphql-v1/objects/user-claims.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`userDelete`](/reference/legacy/graphql-v1/mutations/user-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`userDiscounts`](/reference/legacy/graphql-v1/queries/user-discounts.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`usergroupDelete`](/reference/legacy/graphql-v1/mutations/usergroup-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`UsergroupSearchArguments`](/reference/legacy/graphql-v1/inputs/usergroup-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UsergroupsResponse`](/reference/legacy/graphql-v1/objects/usergroups-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UserManagementAttributeSearchInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeValueInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`valueset`](/reference/legacy/graphql-v1/queries/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`valuesetDelete`](/reference/legacy/graphql-v1/mutations/valueset-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`ValuesetItem`](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetItemCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`valuesetItemDelete`](/reference/legacy/graphql-v1/mutations/valueset-item-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`ValuesetItemResponse`](/reference/legacy/graphql-v1/objects/valueset-item-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetItemSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-item-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`valuesetItemUpdate`](/reference/legacy/graphql-v1/mutations/valueset-item-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`ValuesetResponse`](/reference/legacy/graphql-v1/objects/valueset-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`valuesetUpdate`](/reference/legacy/graphql-v1/mutations/valueset-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`VerifyToken`](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`warehouse`](/reference/legacy/graphql-v1/queries/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`WarehouseAddress`](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehousesResponse`](/reference/legacy/graphql-v1/objects/warehouses-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehousesSearchInput`](/reference/legacy/graphql-v1/inputs/warehouses-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## JSONObject

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/jsonobject

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).

```graphql
scalar JSONObject
```

### Returned By

[`businessRuleJDM`](/reference/legacy/graphql-v1/queries/business-rule-jdm.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/>

### Member Of

[`BusinessRule`](/reference/legacy/graphql-v1/objects/business-rule.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartResponseData`](/reference/legacy/graphql-v1/objects/cart-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CsvRecordError`](/reference/legacy/graphql-v1/objects/csv-record-error.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailSendEventInput`](/reference/legacy/graphql-v1/inputs/email-send-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Firebase`](/reference/legacy/graphql-v1/objects/firebase.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderResponseData`](/reference/legacy/graphql-v1/objects/tender-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`VerifyToken`](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## String

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/string

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

```graphql
scalar String
```

### Returned By

[`addCompanyManager`](/reference/legacy/graphql-v1/mutations/add-company-manager.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`companyDelete`](/reference/legacy/graphql-v1/mutations/company-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`passwordResetLink`](/reference/legacy/graphql-v1/mutations/password-reset-link.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`removeCompanyManager`](/reference/legacy/graphql-v1/mutations/remove-company-manager.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`tenderDelete`](/reference/legacy/graphql-v1/mutations/tender-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/>

### Member Of

[`Address`](/reference/legacy/graphql-v1/objects/address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Attribute`](/reference/legacy/graphql-v1/objects/attribute.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescription`](/reference/legacy/graphql-v1/objects/attribute-description.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeDescriptionSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-description-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeFilter`](/reference/legacy/graphql-v1/objects/attribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeFilterInput`](/reference/legacy/graphql-v1/inputs/attribute-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`AttributeTextFilter`](/reference/legacy/graphql-v1/objects/attribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValue`](/reference/legacy/graphql-v1/objects/attribute-value.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`AttributeValueObjectSearchInput`](/reference/legacy/graphql-v1/inputs/attribute-value-object-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`authentication`](/reference/legacy/graphql-v1/queries/authentication.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`authenticationDelete`](/reference/legacy/graphql-v1/mutations/authentication-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Base64File`](/reference/legacy/graphql-v1/objects/base-64-file.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Base64FileInput`](/reference/legacy/graphql-v1/inputs/base-64-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`bulkPrice`](/reference/legacy/graphql-v1/queries/bulk-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`Bundle`](/reference/legacy/graphql-v1/objects/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`bundle`](/reference/legacy/graphql-v1/queries/bundle.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`bundles`](/reference/legacy/graphql-v1/queries/bundles.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BundleSearchInput`](/reference/legacy/graphql-v1/inputs/bundle-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessHours`](/reference/legacy/graphql-v1/objects/business-hours.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessHoursInput`](/reference/legacy/graphql-v1/inputs/business-hours-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleActionField`](/reference/legacy/graphql-v1/objects/business-rule-action-field.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleArrayExpression`](/reference/legacy/graphql-v1/objects/business-rule-array-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleArrayExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-array-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleComplexExpression`](/reference/legacy/graphql-v1/objects/business-rule-complex-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleComplexExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-complex-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDateExpression`](/reference/legacy/graphql-v1/objects/business-rule-date-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDateExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-date-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTable`](/reference/legacy/graphql-v1/objects/business-rule-decision-table.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableAddColumnInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-add-column-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableCell`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-cell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableInputOutput`](/reference/legacy/graphql-v1/objects/business-rule-decision-table-input-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleDecisionTableSetCellInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleDecisionTableUpdateInput`](/reference/legacy/graphql-v1/inputs/business-rule-decision-table-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleEdge`](/reference/legacy/graphql-v1/objects/business-rule-edge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinition`](/reference/legacy/graphql-v1/objects/business-rule-field-definition.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleFieldDefinitionGroup`](/reference/legacy/graphql-v1/objects/business-rule-field-definition-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`businessRuleFieldDefinitions`](/reference/legacy/graphql-v1/queries/business-rule-field-definitions.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BusinessRuleInput`](/reference/legacy/graphql-v1/objects/business-rule-input.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`businessRuleJDM`](/reference/legacy/graphql-v1/queries/business-rule-jdm.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`BusinessRuleNumberExpression`](/reference/legacy/graphql-v1/objects/business-rule-number-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleNumberExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-number-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleOutput`](/reference/legacy/graphql-v1/objects/business-rule-output.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpression`](/reference/legacy/graphql-v1/objects/business-rule-string-expression.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`BusinessRuleStringExpressionInput`](/reference/legacy/graphql-v1/inputs/business-rule-string-expression-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`BusinessRuleSubExpressionGroup`](/reference/legacy/graphql-v1/objects/business-rule-sub-expression-group.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Carrier`](/reference/legacy/graphql-v1/objects/carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CarrierCreateInput`](/reference/legacy/graphql-v1/inputs/carrier-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarriersSearchInput`](/reference/legacy/graphql-v1/inputs/carriers-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CarrierUpdateInput`](/reference/legacy/graphql-v1/inputs/carrier-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Cart`](/reference/legacy/graphql-v1/objects/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`cart`](/reference/legacy/graphql-v1/queries/cart.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`cartAddActionCode`](/reference/legacy/graphql-v1/mutations/cart-add-action-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartAddBundleInput`](/reference/legacy/graphql-v1/inputs/cart-add-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartAddItemInput`](/reference/legacy/graphql-v1/inputs/cart-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartAddress`](/reference/legacy/graphql-v1/objects/cart-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`cartAddVoucherCode`](/reference/legacy/graphql-v1/mutations/cart-add-voucher-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartBaseItem`](/reference/legacy/graphql-v1/objects/cart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartCarrier`](/reference/legacy/graphql-v1/objects/cart-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`cartDelete`](/reference/legacy/graphql-v1/mutations/cart-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartDeleteItemInput`](/reference/legacy/graphql-v1/inputs/cart-delete-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartDeleteResponse`](/reference/legacy/graphql-v1/objects/cart-delete-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartIncentive`](/reference/legacy/graphql-v1/objects/cart-incentive.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartItemSurcharge`](/reference/legacy/graphql-v1/objects/cart-item-surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartMainItem`](/reference/legacy/graphql-v1/objects/cart-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPaymentData`](/reference/legacy/graphql-v1/objects/cart-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPaymentDataInput`](/reference/legacy/graphql-v1/inputs/cart-payment-data-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartPaymethod`](/reference/legacy/graphql-v1/objects/cart-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageData`](/reference/legacy/graphql-v1/objects/cart-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartPostageDataInput`](/reference/legacy/graphql-v1/inputs/cart-postage-data-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartProcessInput`](/reference/legacy/graphql-v1/inputs/cart-process-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`cartRemoveActionCode`](/reference/legacy/graphql-v1/mutations/cart-remove-action-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`cartRemoveVoucherCode`](/reference/legacy/graphql-v1/mutations/cart-remove-voucher-code.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartResponseData`](/reference/legacy/graphql-v1/objects/cart-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CartSetUserInput`](/reference/legacy/graphql-v1/inputs/cart-set-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/cart-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateInput`](/reference/legacy/graphql-v1/inputs/cart-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartUpdateItemInput`](/reference/legacy/graphql-v1/inputs/cart-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`cartUpdateItems`](/reference/legacy/graphql-v1/mutations/cart-update-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`CartUpdateItemsInput`](/reference/legacy/graphql-v1/inputs/cart-update-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CartVoucher`](/reference/legacy/graphql-v1/objects/cart-voucher.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Category`](/reference/legacy/graphql-v1/objects/category.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`category`](/reference/legacy/graphql-v1/queries/category.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`CategorySearchInput`](/reference/legacy/graphql-v1/inputs/category-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Channel`](/reference/legacy/graphql-v1/objects/channel.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`claimsReset`](/reference/legacy/graphql-v1/mutations/claims-reset.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`Cluster`](/reference/legacy/graphql-v1/objects/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`cluster`](/reference/legacy/graphql-v1/queries/cluster.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ClusterDrillDown`](/reference/legacy/graphql-v1/objects/cluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Company`](/reference/legacy/graphql-v1/objects/company.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CompanyAddressCreateInput`](/reference/legacy/graphql-v1/inputs/company-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanyAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/company-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CompanySearchArguments`](/reference/legacy/graphql-v1/inputs/company-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Contact`](/reference/legacy/graphql-v1/objects/contact.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ContactSearchArguments`](/reference/legacy/graphql-v1/inputs/contact-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateAuthenticationInput`](/reference/legacy/graphql-v1/inputs/create-authentication-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateBundleInput`](/reference/legacy/graphql-v1/inputs/create-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateCategoryInput`](/reference/legacy/graphql-v1/inputs/create-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateCompanyInput`](/reference/legacy/graphql-v1/inputs/create-company-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateContactInput`](/reference/legacy/graphql-v1/inputs/create-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateInventoryInput`](/reference/legacy/graphql-v1/inputs/create-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreatePaymentInput`](/reference/legacy/graphql-v1/inputs/create-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateProductInput`](/reference/legacy/graphql-v1/inputs/create-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateSparePartInput`](/reference/legacy/graphql-v1/inputs/create-spare-part-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateTaxInput`](/reference/legacy/graphql-v1/inputs/create-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateTransactionInput`](/reference/legacy/graphql-v1/inputs/create-transaction-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUsergroupInput`](/reference/legacy/graphql-v1/inputs/create-usergroup-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateUserInput`](/reference/legacy/graphql-v1/inputs/create-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CreateWarehouseInput`](/reference/legacy/graphql-v1/inputs/create-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CropInput`](/reference/legacy/graphql-v1/inputs/crop-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Crossupsell`](/reference/legacy/graphql-v1/objects/crossupsell.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CrossupsellInput`](/reference/legacy/graphql-v1/inputs/crossupsell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CrossupsellTypesInput`](/reference/legacy/graphql-v1/inputs/crossupsell-types-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CsvRecordError`](/reference/legacy/graphql-v1/objects/csv-record-error.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Customer`](/reference/legacy/graphql-v1/objects/customer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`CustomerAddressCreateInput`](/reference/legacy/graphql-v1/inputs/customer-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/customer-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerInput`](/reference/legacy/graphql-v1/inputs/customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`CustomerSearchArguments`](/reference/legacy/graphql-v1/inputs/customer-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`DateSearchInput`](/reference/legacy/graphql-v1/inputs/date-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`defaultPrice`](/reference/legacy/graphql-v1/queries/default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`DeleteMediaAttachmentResponse`](/reference/legacy/graphql-v1/objects/delete-media-attachment-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`DeleteMediaDocumentResponse`](/reference/legacy/graphql-v1/objects/delete-media-document-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`DeleteMediaImageResponse`](/reference/legacy/graphql-v1/objects/delete-media-image-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`DeleteMediaVideoResponse`](/reference/legacy/graphql-v1/objects/delete-media-video-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`deprecated`](/reference/legacy/graphql-v1/directives/deprecated.mdx) <Badge class="badge badge--secondary badge--relation" text="directive"/><Bullet />[`Discount`](/reference/legacy/graphql-v1/objects/discount.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`DocumentCsvMapping`](/reference/legacy/graphql-v1/inputs/document-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailEventInput`](/reference/legacy/graphql-v1/inputs/email-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailSendContactInput`](/reference/legacy/graphql-v1/inputs/email-send-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`EmailSendEventInput`](/reference/legacy/graphql-v1/inputs/email-send-event-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExchangeRefreshTokenInput`](/reference/legacy/graphql-v1/inputs/exchange-refresh-token-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`explainPrice`](/reference/legacy/graphql-v1/queries/explain-price.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ExternalAddress`](/reference/legacy/graphql-v1/objects/external-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ExternalAddressCreateInput`](/reference/legacy/graphql-v1/inputs/external-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/external-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ExternalReferenceInput`](/reference/legacy/graphql-v1/inputs/external-reference-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteList`](/reference/legacy/graphql-v1/objects/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`favoriteList`](/reference/legacy/graphql-v1/queries/favorite-list.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`favoriteListAddItems`](/reference/legacy/graphql-v1/mutations/favorite-list-add-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListClearItems`](/reference/legacy/graphql-v1/mutations/favorite-list-clear-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListDelete`](/reference/legacy/graphql-v1/mutations/favorite-list-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`favoriteListRemoveItems`](/reference/legacy/graphql-v1/mutations/favorite-list-remove-items.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`FavoriteListsBaseSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-base-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsCreateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsSearchInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`FavoriteListsUpdateInput`](/reference/legacy/graphql-v1/inputs/favorite-lists-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`favoriteListUpdate`](/reference/legacy/graphql-v1/mutations/favorite-list-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`FilterAvailableAttributeInput`](/reference/legacy/graphql-v1/inputs/filter-available-attribute-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Firebase`](/reference/legacy/graphql-v1/objects/firebase.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`GCIPMetadata`](/reference/legacy/graphql-v1/objects/gcipmetadata.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`GCIPProviderData`](/reference/legacy/graphql-v1/objects/gcipprovider-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`GCIPUser`](/reference/legacy/graphql-v1/objects/gcipuser.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IAttributeFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IAttributeTextFilter`](/reference/legacy/graphql-v1/interfaces/iattribute-text-filter.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseProduct`](/reference/legacy/graphql-v1/interfaces/ibase-product.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBaseUser`](/reference/legacy/graphql-v1/interfaces/ibase-user.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBundle`](/reference/legacy/graphql-v1/interfaces/ibundle.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IBusinessRuleNode`](/reference/legacy/graphql-v1/interfaces/ibusiness-rule-node.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICart`](/reference/legacy/graphql-v1/interfaces/icart.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICartBaseItem`](/reference/legacy/graphql-v1/interfaces/icart-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ICluster`](/reference/legacy/graphql-v1/interfaces/icluster.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IClusterDrillDown`](/reference/legacy/graphql-v1/interfaces/icluster-drill-down.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ImageCsvMapping`](/reference/legacy/graphql-v1/inputs/image-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ImageTransformationInput`](/reference/legacy/graphql-v1/inputs/image-transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ImageVariant`](/reference/legacy/graphql-v1/objects/image-variant.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IncentiveRuleOrderItemSetCellInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-order-item-set-cell-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`IncentiveRuleSetActionInput`](/reference/legacy/graphql-v1/inputs/incentive-rule-set-action-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Inventory`](/reference/legacy/graphql-v1/objects/inventory.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryCsvMapping`](/reference/legacy/graphql-v1/inputs/inventory-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`InventoryDeleteResponse`](/reference/legacy/graphql-v1/objects/inventory-delete-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`InventoryResponse`](/reference/legacy/graphql-v1/objects/inventory-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`IProduct`](/reference/legacy/graphql-v1/interfaces/iproduct.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IProductOffer`](/reference/legacy/graphql-v1/interfaces/iproduct-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`IResource`](/reference/legacy/graphql-v1/interfaces/iresource.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`ITenderBaseItem`](/reference/legacy/graphql-v1/interfaces/itender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="interface"/><Bullet />[`LocalizedAttachment`](/reference/legacy/graphql-v1/objects/localized-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LocalizedDocument`](/reference/legacy/graphql-v1/objects/localized-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LocalizedImage`](/reference/legacy/graphql-v1/objects/localized-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LocalizedString`](/reference/legacy/graphql-v1/objects/localized-string.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LocalizedStringArray`](/reference/legacy/graphql-v1/objects/localized-string-array.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LocalizedStringArrayInput`](/reference/legacy/graphql-v1/inputs/localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`LocalizedStringInput`](/reference/legacy/graphql-v1/inputs/localized-string-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`LocalizedVideo`](/reference/legacy/graphql-v1/objects/localized-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Login`](/reference/legacy/graphql-v1/objects/login.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`LoginInput`](/reference/legacy/graphql-v1/inputs/login-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Logout`](/reference/legacy/graphql-v1/objects/logout.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`machine`](/reference/legacy/graphql-v1/queries/machine.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`machineDelete`](/reference/legacy/graphql-v1/mutations/machine-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaAttachment`](/reference/legacy/graphql-v1/objects/media-attachment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`mediaAttachmentDelete`](/reference/legacy/graphql-v1/mutations/media-attachment-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaAttachmentSearchInput`](/reference/legacy/graphql-v1/inputs/media-attachment-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`mediaAttachmentUpdate`](/reference/legacy/graphql-v1/mutations/media-attachment-update.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaBase64FileInput`](/reference/legacy/graphql-v1/inputs/media-base-64-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`mediaDocument`](/reference/legacy/graphql-v1/deprecated/queries/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`MediaDocument`](/reference/legacy/graphql-v1/objects/media-document.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`mediaDocumentDelete`](/reference/legacy/graphql-v1/mutations/media-document-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaDocumentSearchInput`](/reference/legacy/graphql-v1/inputs/media-document-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`mediaImage`](/reference/legacy/graphql-v1/deprecated/queries/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`MediaImage`](/reference/legacy/graphql-v1/objects/media-image.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`mediaImageDelete`](/reference/legacy/graphql-v1/mutations/media-image-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaImageSearchInput`](/reference/legacy/graphql-v1/inputs/media-image-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaLocalizedStringArrayInput`](/reference/legacy/graphql-v1/inputs/media-localized-string-array-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`MediaLocalizedStringInput`](/reference/legacy/graphql-v1/inputs/media-localized-string-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`mediaVideo`](/reference/legacy/graphql-v1/deprecated/queries/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`MediaVideo`](/reference/legacy/graphql-v1/objects/media-video.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`mediaVideoDelete`](/reference/legacy/graphql-v1/mutations/media-video-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`MediaVideoSearchInput`](/reference/legacy/graphql-v1/inputs/media-video-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Order`](/reference/legacy/graphql-v1/objects/order.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`order`](/reference/legacy/graphql-v1/queries/order.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`OrderCreateInput`](/reference/legacy/graphql-v1/inputs/order-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItem`](/reference/legacy/graphql-v1/objects/order-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderItemCreateInput`](/reference/legacy/graphql-v1/inputs/order-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderItemUpdateInput`](/reference/legacy/graphql-v1/inputs/order-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentData`](/reference/legacy/graphql-v1/objects/order-payment-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPaymentInput`](/reference/legacy/graphql-v1/inputs/order-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPaymentUpdateInput`](/reference/legacy/graphql-v1/inputs/order-payment-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageData`](/reference/legacy/graphql-v1/objects/order-postage-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`OrderPostageInput`](/reference/legacy/graphql-v1/inputs/order-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderPostageUpdateInput`](/reference/legacy/graphql-v1/inputs/order-postage-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSearchArguments`](/reference/legacy/graphql-v1/inputs/order-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderSetStatusInput`](/reference/legacy/graphql-v1/inputs/order-set-status-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/order-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`OrderUpdateInput`](/reference/legacy/graphql-v1/inputs/order-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PasswordRecoveryLinkInput`](/reference/legacy/graphql-v1/inputs/password-recovery-link-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`passwordResetLink`](/reference/legacy/graphql-v1/mutations/password-reset-link.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`PasswordResetLinkEmailInput`](/reference/legacy/graphql-v1/inputs/password-reset-link-email-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Payment`](/reference/legacy/graphql-v1/objects/payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PayMethod`](/reference/legacy/graphql-v1/objects/pay-method.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PayMethodCreateInput`](/reference/legacy/graphql-v1/inputs/pay-method-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodSearchInput`](/reference/legacy/graphql-v1/inputs/pay-method-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`PayMethodUpdateInput`](/reference/legacy/graphql-v1/inputs/pay-method-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Product`](/reference/legacy/graphql-v1/objects/product.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`product`](/reference/legacy/graphql-v1/queries/product.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ProductDefaultPrice`](/reference/legacy/graphql-v1/objects/product-default-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductOffer`](/reference/legacy/graphql-v1/objects/product-offer.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ProductPrice`](/reference/legacy/graphql-v1/objects/product-price.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`products`](/reference/legacy/graphql-v1/queries/products.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`ProductSource`](/reference/legacy/graphql-v1/objects/product-source.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`PublishEmailEventResponse`](/reference/legacy/graphql-v1/objects/publish-email-event-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RangeFilterInput`](/reference/legacy/graphql-v1/inputs/range-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RefreshTokenResponse`](/reference/legacy/graphql-v1/objects/refresh-token-response.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`RegisterContactInput`](/reference/legacy/graphql-v1/inputs/register-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterCustomerInput`](/reference/legacy/graphql-v1/inputs/register-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserInput`](/reference/legacy/graphql-v1/inputs/register-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`RegisterUserSession`](/reference/legacy/graphql-v1/objects/register-user-session.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`SearchByInput`](/reference/legacy/graphql-v1/inputs/search-by-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SendOrderConfirmResponseType`](/reference/legacy/graphql-v1/objects/send-order-confirm-response-type.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Shipment`](/reference/legacy/graphql-v1/objects/shipment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ShipmentItem`](/reference/legacy/graphql-v1/objects/shipment-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Shop`](/reference/legacy/graphql-v1/objects/shop.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Site`](/reference/legacy/graphql-v1/objects/site.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Source`](/reference/legacy/graphql-v1/inputs/source.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SourceInput`](/reference/legacy/graphql-v1/inputs/source-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`SparePart`](/reference/legacy/graphql-v1/objects/spare-part.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`specifiedBy`](/reference/legacy/graphql-v1/directives/specified-by.mdx) <Badge class="badge badge--secondary badge--relation" text="directive"/><Bullet />[`StandardFileUploadInput`](/reference/legacy/graphql-v1/inputs/standard-file-upload-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Surcharge`](/reference/legacy/graphql-v1/objects/surcharge.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Tax`](/reference/legacy/graphql-v1/objects/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tax`](/reference/legacy/graphql-v1/queries/tax.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`TaxSearchInput`](/reference/legacy/graphql-v1/inputs/tax-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Tender`](/reference/legacy/graphql-v1/objects/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tender`](/reference/legacy/graphql-v1/queries/tender.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`TenderAddItemInput`](/reference/legacy/graphql-v1/inputs/tender-add-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderAddItemsInput`](/reference/legacy/graphql-v1/inputs/tender-add-items-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderAddress`](/reference/legacy/graphql-v1/objects/tender-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`tenderApplyIncentives`](/reference/legacy/graphql-v1/mutations/tender-apply-incentives.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`TenderBaseItem`](/reference/legacy/graphql-v1/objects/tender-base-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderCarrier`](/reference/legacy/graphql-v1/objects/tender-carrier.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderChildItemInput`](/reference/legacy/graphql-v1/inputs/tender-child-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`tenderDelete`](/reference/legacy/graphql-v1/mutations/tender-delete.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`TenderDeleteItemInput`](/reference/legacy/graphql-v1/inputs/tender-delete-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderDiscountInput`](/reference/legacy/graphql-v1/inputs/tender-discount-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderMainItem`](/reference/legacy/graphql-v1/objects/tender-main-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPayment`](/reference/legacy/graphql-v1/objects/tender-payment.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPaymentInput`](/reference/legacy/graphql-v1/inputs/tender-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderPaymethod`](/reference/legacy/graphql-v1/objects/tender-paymethod.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostage`](/reference/legacy/graphql-v1/objects/tender-postage.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderPostageInput`](/reference/legacy/graphql-v1/inputs/tender-postage-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`tenderProcess`](/reference/legacy/graphql-v1/mutations/tender-process.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`TenderResponseData`](/reference/legacy/graphql-v1/objects/tender-response-data.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TenderStart`](/reference/legacy/graphql-v1/inputs/tender-start.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderUpdateAddressInput`](/reference/legacy/graphql-v1/inputs/tender-update-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TenderUpdateInput`](/reference/legacy/graphql-v1/inputs/tender-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`tenderUpdateInvoiceUser`](/reference/legacy/graphql-v1/mutations/tender-update-invoice-user.mdx) <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />[`TenderUpdateItemInput`](/reference/legacy/graphql-v1/inputs/tender-update-item-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TextFilterInput`](/reference/legacy/graphql-v1/inputs/text-filter-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`TrackAndTrace`](/reference/legacy/graphql-v1/objects/track-and-trace.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Transaction`](/reference/legacy/graphql-v1/objects/transaction.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`TransformationInput`](/reference/legacy/graphql-v1/inputs/transformation-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateBundleInput`](/reference/legacy/graphql-v1/inputs/update-bundle-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCategoryInput`](/reference/legacy/graphql-v1/inputs/update-category-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCompanyInput`](/reference/legacy/graphql-v1/inputs/update-company-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateContactInput`](/reference/legacy/graphql-v1/inputs/update-contact-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateCustomerInput`](/reference/legacy/graphql-v1/inputs/update-customer-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateInventoryInput`](/reference/legacy/graphql-v1/inputs/update-inventory-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaDocumentInput`](/reference/legacy/graphql-v1/inputs/update-media-document-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaImageInput`](/reference/legacy/graphql-v1/inputs/update-media-image-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateMediaVideoInput`](/reference/legacy/graphql-v1/inputs/update-media-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdatePaymentInput`](/reference/legacy/graphql-v1/inputs/update-payment-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateProductInput`](/reference/legacy/graphql-v1/inputs/update-product-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateTaxInput`](/reference/legacy/graphql-v1/inputs/update-tax-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUsergroupInput`](/reference/legacy/graphql-v1/inputs/update-usergroup-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateUserInput`](/reference/legacy/graphql-v1/inputs/update-user-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseAddressInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-address-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UpdateWarehouseInput`](/reference/legacy/graphql-v1/inputs/update-warehouse-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UploadFileInput`](/reference/legacy/graphql-v1/inputs/upload-file-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UploadVideoInput`](/reference/legacy/graphql-v1/inputs/upload-video-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UrlFileUploadInput`](/reference/legacy/graphql-v1/inputs/url-file-upload-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`User`](/reference/legacy/graphql-v1/objects/user.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`user`](/reference/legacy/graphql-v1/queries/user.mdx) <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />[`UserAddressCreateInput`](/reference/legacy/graphql-v1/inputs/user-address-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserAddressUpdateInput`](/reference/legacy/graphql-v1/inputs/user-address-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserClaims`](/reference/legacy/graphql-v1/objects/user-claims.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`Usergroup`](/reference/legacy/graphql-v1/objects/usergroup.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`UsergroupSearchArguments`](/reference/legacy/graphql-v1/inputs/usergroup-search-arguments.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeSearchInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`UserManagementAttributeValueInput`](/reference/legacy/graphql-v1/inputs/user-management-attribute-value-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Valueset`](/reference/legacy/graphql-v1/objects/valueset.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItem`](/reference/legacy/graphql-v1/objects/valueset-item.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`ValuesetItemCreateInput`](/reference/legacy/graphql-v1/inputs/valueset-item-create-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItemSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-item-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetItemUpdateInput`](/reference/legacy/graphql-v1/inputs/valueset-item-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetSearchInput`](/reference/legacy/graphql-v1/inputs/valueset-search-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ValuesetUpdateInput`](/reference/legacy/graphql-v1/inputs/valueset-update-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`VerifyToken`](/reference/legacy/graphql-v1/objects/verify-token.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`VerifyTokenInput`](/reference/legacy/graphql-v1/inputs/verify-token-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`VideoCsvMapping`](/reference/legacy/graphql-v1/inputs/video-csv-mapping.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`Warehouse`](/reference/legacy/graphql-v1/objects/warehouse.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/><Bullet />[`WarehouseAddress`](/reference/legacy/graphql-v1/objects/warehouse-address.mdx) <Badge class="badge badge--secondary badge--relation" text="object"/>

---

## Upload

URL: https://docs.propeller-commerce.com/reference/legacy/graphql-v1/scalars/upload

export const Bullet = () => (
  <>
    <span
      style={{
        fontWeight: "normal",
        fontSize: ".5em",
        color: "var(--ifm-color-secondary-darkest)",
      }}
    >
      &nbsp;●&nbsp;
    </span>
  </>
);

export const SpecifiedBy = (props) => (
  <>
    Specification
    <a
      className="link"
      style={{ fontSize: "1.5em", paddingLeft: "4px" }}
      target="_blank"
      href={props.url}
      title={"Specified by " + props.url}
    >
      ⎘
    </a>
  </>
);

export const Badge = (props) => (
  <>
    <span className={props.class}>{props.text}</span>
  </>
);



export const Details = ({
  dataOpen,
  dataClose,
  children,
  startOpen = false,
}) => {
  const [open, setOpen] = useState(startOpen);
  return (
    <details
      {...(open ? { open: true } : {})}
      className="details"
      style={{
        border: "none",
        boxShadow: "none",
        background: "var(--ifm-background-color)",
      }}
    >
      <summary
        onClick={(e) => {
          e.preventDefault();
          setOpen((open) => !open);
        }}
        style={{ listStyle: "none" }}
      >
        {open ? dataOpen : dataClose}
      </summary>
      {open && children}
    </details>
  );
};

The `Upload` scalar type represents a file upload.

```graphql
scalar Upload
```

### Member Of

[`DocumentCsvInput`](/reference/legacy/graphql-v1/inputs/document-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`ImageCsvInput`](/reference/legacy/graphql-v1/inputs/image-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`InventoryCsvInput`](/reference/legacy/graphql-v1/inputs/inventory-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`StandardFileUploadInput`](/reference/legacy/graphql-v1/inputs/standard-file-upload-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/><Bullet />[`VideoCsvInput`](/reference/legacy/graphql-v1/inputs/video-csv-input.mdx) <Badge class="badge badge--secondary badge--relation" text="input"/>

---

## Legacy API Reference

URL: https://docs.propeller-commerce.com/reference/legacy

# Legacy API Reference

<LegacyBanner />

Reference documentation for legacy API versions, maintained for partners with existing implementations.

| API | Status | Description |
|---|---|---|
| [GraphQL v1](/reference/legacy/graphql-v1) | Available | Full schema reference auto-generated from the v1 GraphQL endpoint |
| [REST v1](/reference/legacy/rest-v1) | Available | Full endpoint reference for the REST v1 API |
| [REST SonarCloud](/reference/legacy/rest-sonar) | Available | Full endpoint reference for the REST SonarCloud variant API |

---

## Add Setting to Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/add-setting-to-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Add Setting to Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `attributeName` | yes |
| `displayType` | yes |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_SIZE111"},"displayType":{"type":"string","example":"dropdown"},"priority":{"type":"number","example":2}}},"examples":{"Add Setting to Cluster Config":{"value":{"attributeName":"PROPELLER_SIZE111","displayType":"dropdown","priority":2}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Add Setting to Cluster Config - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"169"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:56:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"916787ee-871a-4792-b7fd-2fd909098684"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_SIZE"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"dropdown"},"id":{"type":"number","example":116},"priority":{"type":"number","example":2}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config Setting created"},"example":["Cluster Config Setting created"]},"total":{"type":"number","example":1}}},"examples":{"Add Setting to Cluster Config - 201":{"value":{"data":{"attributeName":"PROPELLER_SIZE","clusterConfigId":11,"displayType":"dropdown","id":116,"priority":2},"messages":["Cluster Config Setting created"],"total":1}}}}}},"404":{"description":"Add Setting to Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"214"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:56:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"74e2a5e4-55fa-4b46-abeb-aeaab16d5576"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."},"example":["Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Add Setting to Cluster Config - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## API Reference

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/api-reference.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 1.0.0"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"API Reference"}
>
</Heading>



The Propeller REST API is based on resource-oriented URL's, returns JSON-encoded responses and uses standard HTTP response codes, authentication and HTTP methods. The main goal of the REST API is efficiently importing/exporting large amounts of data in/out of the Propeller platform.

## HTTP methods

Propeller REST API supports POST, GET, PATCH, and DELETE HTTP methods.

## Authentication

The REST API uses the [oAuth 2.0 client credentials grant type](https://oauth.net/2/grant-types/client-credentials/) for authentication, every API requests needs a valid access token.

## Request an access token

1. Request an access token by executing [a POST request](/reference/legacy/rest-sonar/get-access-token)  to the [token endpoint](https://api.helice.cloud/oauth2/token).  This POST request should include the Client Id and Client Secret.
2. A successful access token request will return the following result:
    

```json
{
  "refresh_token_expires_in": "0",
  "api_product_list": "[Propeller REST APIs]",
  "api_product_list_json": [
    "Propeller REST APIs"
  ],
  "organization_name": "propeller-platform-prod",
  "developer.email": "developer@propel.us",
  "token_type": "BearerToken",
  "issued_at": "1646873717224",
  "client_id": "veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT",
  "access_token": "ARAo4GjuI1bGSyenSKx5oYfFGuFQ",
  "application_name": "a1ca275a-2abb-4bd3-82b0-3ae699d75e40",
  "scope": "",
  "expires_in": "1899",
  "refresh_count": "0",
  "status": "approved"
}
```
3. Parse the `access_token` value from this result and use it as a [bearer token](https://oauth.net/2/bearer-tokens/) in subsequent API requests.

4. After 30 minutes the requested `access_token` expires and a new token needs to be requested.

## Lookup keys

The REST API offers multiple ways to identify resources. In Propeller terminology these are called lookup keys. For example: a product can be identified by its Propellor internal `id`but also by an `sku.` A `sku` however, is not guaranteed to be unique in the catalogue, as multiple `products` with the same `sku` can exist. If multiple resources are found based on the lookup key / value combination the result of the request will be an error. In case of multiple `products` with the same `sku` a GET or PATCH request to this product will result in an error.

| **Lookup Key** | **Description** |
| --- | --- |
| `id` | Unique Propeller id of an object |
| `externalId` | Unique external id |
| `sourceId/source` | External system unique id to a Propeller resource. `sourceId` always needs to be combined with a `source`. Source is typically the name of a supplier or ERP system the data originates from. |
| `sku` | Stock-keeping unit code referencing a product |
| `supplierCode/supplier` | Code of a supplier referencing a product |
| `code` | Code referencing any other resource (e.g. a pricesheet) |

Source Id/ Source lookup key is most commonly used in [Bulk endpoints](/reference/legacy/rest-sonar/api-reference#bulk-endpoints). If you're creating/ updating products from an external system, the name of that system would typically be the `source` and `sourceId` would be the product's id or code in that system. This id should be unique in that system and the combination source/sourceId is unique in Propeller. When using the GET, DELETE, UPDATE endpoints with lookup key `sourceId` you can use it without `source`, but if multiple resources are found you will get an error. In that case use `source` as well.

Supplier code / supplier is another common way of looking up products. The difference between the sourceId is that the combination does not have to be unique. When it's not and you try to use the GET, UPDATE, DELETE endpoints you will get an error that multiple resources have been found.

## Expanding resources

Some resources allow to request additional information as an expanded resource by using the `expands` request parameter. This parameter is available on all GET REST API requests and applies to the response of that request only.

In many cases, an object contains a related object in its response properties. For example, an `Orderitem` may have an associated `Product` id. Those objects can be expanded inline with the `expands` request parameter.

| **Expand parameter** | **Description** |
| --- | --- |
| `orderItems` | expands the `order` resource with `orderItems` |
| `orderItems.product` | expands the `orderItems` resource with the `product` resource |
| `translation` | expands translated fields for all available languages. |
| `inventoryBalance` | expands all inventory resources for a `product` |
| `defaultProduct` | expand the `cluster` or `option` resource with the default `product` resource |

## Pagination

Querying resources and especially retrieving a lot of data can be potentially really expensive. Therefor, endpoints that retrieve a lot of results are paginated. Use `page` and `offset` query parameters to request a certain page of the result in GET endpoints. When using search endpoints (POST HTTP method), `page` and `offset` are part of the payload.

### Page

You can request a certain page of the result using the `page` query/ payload parameter.

### Offset

You can set the maximum number of results to return using the `offset` query/ payload parameter. The minimum value is `1` and the maximum can differ per API. This is specified in more details in endpoints that support pagination. The default `offset` on most endpoints is `12`.

### Response

This response retrieves 2 results in the data, the number of results per page is 2 and page requested is 1. `total` is the number of records for the page requested, while `itemsFound` is the total number of results.

```json
{
  "data": [
    {
      id: 56897
    },
    {
      id: 36975
    }
  ],
  "messages": [
    "Completed"
  ],
  "start": 1,
  "pages": 20,
  "total": 2,
  "offset": 2,
  "itemsFound": 35,
  "end": 2,
  "page": 1
}
```
## Errors

This section describes error codes used in the Propeller platform REST APIs and their meaning. For details about the API-specific error-codes, consult the documentation dedicated to that API.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `10005` | InvalidJSONPayload | 400 | Invalid JSON Payload | JSON provided in payload is not valid |
| `10006` | InvalidLookupKey | 400 | Invalid lookup key | Lookup key is not supported in the specific API. Check API specific lookup keys |
| `10007` | SchemaValidationException | 400 | Schema Validation Error | JSON schema validation. Response contains the details of the issue |
| `10008` | NotFound | 404 | Resource not found | Resource deleted, non-existing or insufficient permissions |
| `10015` | PaginatedResponseException | 400 | Pagination not properly initialized | `offset` or `page` are not initialized properly. These should be positive integers. Possible maximum limit exceeded on `offset` |
| `10016` | LookupKeyNotFound | 400 | Lookup key not found in payload | Bulk endpoints by a certain lookup key require that the lookup key is provided in the payload |
| `10017` | PayloadValidationError | 400 | Payload validation error | Server side validation of the payload. Response contains the details of the issue |
| `10018` | TranslationNotFound | 404 | Translation not found | Resource deleted, non-existing or insufficient permissions |
| `10019` | WarehouseNotFound | 404 | Warehouse not found | Resource deleted, non-existing or insufficient permissions |
| `10020` | WarehouseInvalidConfiguration | 400 | Warehouse invalid configuration | Warehouse not properly configured, e.g. not a pick up location |

### Error Response

When an API call results in an error, the response contains the `error` property which is an object with the following properties:

| **Property** | **Type** | **Description** |
| --- | --- | --- |
| `code` | string | Error code. Generic error codes are listed [here](/reference/legacy/rest-sonar/api-reference#errors), while API specific error codes are listed in each API |
| `status` | integer | Status code |
| `type` | string | Error type. Generic error types are listed [here](/reference/legacy/rest-sonar/api-reference#errors), while API specific error types are listed in each API |
| `messages` | array\[string\] | An array of error messages |
| `moreInfo` | string | URL to a page containing details about the error (under construction) |

Example error response:

```json
{
  "error": {
    "code": 80006,
    "status": 404,
    "type": "ProductNotFound",
    "messages": [
      "Product with id [481189] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006"
  }
}
```
## Localized String

A localized string is a JSON object used for fields that are translatable. A localized string has two properties: to indicate the language as per [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) and the value of the translated field in that language.

```json
{
    "language": "EN",
    "value": ""
}
```
## Bulk endpoints

Bulk endpoints allow for an efficient way of importing/updating large amounts of data with just a single API call. Traditional REST API functionality would allow for a single resource (e.g. a `product` or `user`) to be created and a second API request to update this resource. Creating and/or updating multiple resources would mean executing multiple API requests. Working with larger number of resources means this approach would generate a significant number of API calls resulting in inefficient use of resources and import processes taking a lot of time.

The Propeller REST API offers "bulk" functionality to efficiently import/update resources. A bulk request typically contains a payload of multiple resources of a single type (e.g. [product](/reference/legacy/rest-sonar/products), [user](/reference/legacy/rest-sonar/users), [category](/reference/legacy/rest-sonar/categories) or [inventory](/reference/legacy/rest-sonar/inventory)). Based on the [lookupKey](/reference/legacy/rest-sonar/api-reference#lookup-keys) Propeller will decide if a resource needs to be created or updated.

Bulk endpoints take away the need for multiple API calls to determine if a resource needs to be created or updated and allow for creating/updating multiple resources in on API request.

## Directives

Directives are a powerful Propeller REST APIs concept only used in bulk endpoints. Use directives for actions that are otherwise only doable via a lot of single endpoint API requests. Directives concept is easiest to understand via use cases.

- Let's assume a large number of products is being created/ updated using the Product Bulk endpoint and Propeller's back office is used to maintain some of the data, e.g. product names. When products are created via the bulk endpoint they should not be created with an empty product name. That name can later be changed and we don't want to overwrite it. If it were a single resource endpoint, the GET endpoint could be used to check if the product exists, find the name, compare it, etc. That is not really efficient on a large scale. This is where `skipIfNotEmpty` directive comes handy. Use this directive when you only want to set a field with the value from the payload if it's current value is an empty string.
- Another use case is using Propeller to move resources in a different parent container that the one they were originally created in. Let's assume you have a list of products that belong in certain categories and those products are created via the Bulk endpoints. If you decide to maintain the catalogue structure from within Propeller you would typically move products around manually or via Propeller's rule engine. To avoid a Bulk endpoint would move them back to their original endpoint, use the `skipMoveOnUpdate` directive.
- When creating categories/ product translations you typically have a list of all the active translations you want the resource to be translated in. When using a single resource endpoint you can delete translations one by one, but in the Bulk endpoints use `mergeTranslationsOnUpdate` to reset i.e. delete the ones that are not in the payload.
    

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing resource that are not empty | array of field names, API specific  <br />e.g. for `products` : `names`, `descriptions`, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing resource in the parent resource provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a resource that are not provided in the payload | empty array |
| `skipCreate` | Skip creating new, only update existing resources | empty array |

## Use Cases

## Usergroups - users bulk import

The user rest api is typically used in a B2B environment where a predefined set of customers is allowed access to a webshop / portal. Typically those customers are managed in an ERP and/or CRM system and in order for these customers to have access to the webshop, they need to have an account in Propeller meaning these customers need to be imported into Propeller.

A common way for an ERP/CRM system to handle the concept of customers is to have an entity called customer/debtor or relation and within this entity there are one or multiple contacts. The customer/debtor in this case is a company/organization and has a unique `debtorId` . The contacts are typically persons within the organization with each their own e-mail address/telephone number and multiple different invoice, delivery and visiting addresses.

A typical way to get the ERP / CRM customers into Propeller is to create a Propeller [usergroup](/reference/legacy/rest-sonar/usergroups) for each customer and within this `usergroup`, for each contact, a Propeller `user` .

Most of the time the number of customers/contacts which need to be imported will be multiple thousands (if not more). In these cases it is important to use the user and usergroup bulk endpoints, these make sure creating/updating the usergroups / users / addresses / attributes is done in efficiently.

To create the `usergroups` and `users` in Propellor two different bulk endpoints need to be used:

1. the [usergroup bulk endpoint](/reference/legacy/rest-sonar/bulk-usergroups-by-id)
2. the [user bulk endpoint](/reference/legacy/rest-sonar/bulk-users-by-id)
    

Via the usergroup bulk endpoint multiple usergroups representing companies will be created:

```json
{
    "usergroups": [
        {
           "sourceId": "x-123",
           "source": "MBC",
           "language": "EN",
           "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company X"
        },
        {
            "sourceId": "y-456",
            "source": "MBC",
            "language": "EN",
            "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company Y"
         },
        {
            "sourceId": "z-789",
            "source": "MBC",
            "language": "EN",
            "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company Z"
        }
    ]
}
```
The above usergroup bulk endpoint will create or update three usergroups. In this case we use the sourceId / source combination as [lookupKey / lookupValue](#lookup-keys) combination. When using the sourceId / source combination as lookup key, it's possible to identify resources in Propeller based on keys / identifiers from the ERP / CRM system. In the usergroup example, the `source` of the data is Microsoft Business Central (MBC) and the `sourceId` is a unique id / code for a certain customer / organization in Microsoft business central. The combination of the `source` and `sourceId` field will make sure there is only one resource found when referencing a usergroup based on these lookup values.

In advanced setup's its possible to import resources (e.g. customers / contacts) from multiple sources, If usergroups / users would also be imported from a second ERP / CMS system there is a change the `sourceId` would not be available anymore since it is used already by the first import. Because Propeller uses the combination of `sourceId` / `source` to uniquely identify a resource it is possible to import data from multiple different sources using the same sourceId's. A second usergroup import from e.g. Exact Globe could look like this:

```json
{
    "usergroups": [
        {
           "sourceId": "x-123",
           "source": "EXACTGLOBE",
           "language": "EN",
           "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company XX"
        },
        {
            "sourceId": "y-456",
            "source": "EXACTGLOBE",
            "language": "EN",
            "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company YY"
         },
        {
            "sourceId": "z-789",
            "source": "EXACTGLOBE",
            "language": "EN",
            "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company ZZ"
        }
    ]
}
```
In this case the sourceId's from MBC and Exact Globe are the same but because Propeller uses the additional field `source` to identify a resource it is possible to keep using the identifiers generated by the ERP / CRM.

Once the `usergroups` are created the users can be created via the [user bulk endpoint](/reference/legacy/rest-sonar/users). To make sure a `user` is created inside the correct `usergroup` within the `user` resource a parent object is added pointing to the `usergroup` using the `source` / `sourceId` of the `usergroup`

```json
{
    "users": [
        {
            "source": "MBC",
            "sourceId": "3002196",
            "language": "NL",
            "parent": {
                "sourceId": "x-123",
                "source" : "MBC"
            },
            "firstName": "Miles",
            "middleName": "",
            "lastName": "McCoy",
            "debtorId": 12345,
            "login" : "miles@xx.com"
            "company" : "Company X"
            "email": "miles@xx.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Mr.",
            "gender": "M"
        },
        {
            "source": "MBC",
            "sourceId": "3002197",
            "language": "NL",
            "parent": {
                "sourceId": "x-123",
                "source" : "MBC"
            },
            "firstName": "Bernie",
            "middleName": "",
            "lastName": "Sawer",
            "debtorId": 12345,
            "login" : "bernie@xx.com"
            "company": "Company X",
            "email": "bernie@xx.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Mr.",
            "gender": "M"
        },
        {
            "source": "MBC",
            "sourceId": "3002200",
            "language": "NL",
            "parent": {
                "sourceId": "x-456",
                "source" : "MBC"
            },
            "firstName": "Delia",
            "middleName": "Ferdi",
            "lastName": "Finney",
            "debtorId": 67890,
            "login" : "Delia@yy.com"
            "company": "Company Y",
            "email": "bernie@yy.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Ms.",
            "gender": "F"
        }
    ]
}
```
A user / usergroup import is something which needs to be executed frequently since changes in the ERP / CRM should be made available in Propeller, new customers need to get access to the webshop and in certain situations access to the webshop needs to be revoked. Using the [bulk endpoints](/reference/legacy/rest-sonar/api-reference#bulk-endpoints), the payload only needs to be defined once without any logic.

## Order export

Order searching is typically used in combination with exporting orders to ERP/financial/other external systems. Within the Propeller order workflow there will be the need to export orders at a certain point. Most of the times the need to export an order is when the order transitions to a certain status (e.g. CONFIRMED). Via the order search api it is possible to retrieve a list of orders which are in status CONFIRMED and have not been exported yet (using the fields below)

```json
{
    "status": "CONFIRMED",
    "exported": false    
}
```
Once the orders have been exported it is good practice to update the order and mark it as "exported" field using the order update api. Searching for orders with the above payload will then only result in an list of orders without the previously exported orders.

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"HTTP: Basic Auth"}
      value={"basicAuth"}
    >
      
      
      
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                http
              </td>
            </tr><tr>
              <th>
                HTTP Authorization Scheme:
              </th><td>
                basic
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem><TabItem
      label={"HTTP: Bearer Auth"}
      value={"bearerAuth"}
    >
      
      
      
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                http
              </td>
            </tr><tr>
              <th>
                HTTP Authorization Scheme:
              </th><td>
                bearer
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem><TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div>

---

## Attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/attributes.tag

<LegacyBanner />



Attributes are resources custom defined fields which can be created manually via the Propeller Backoffice or imported via the REST API. Attributes are a powerful and flexible mechanism which are usually used to define products' specification. Another use case is when Propeller's resource pre defined properties are simply not sufficient. Attribute resource values can be inherited from their parent resource. For example, if a product attribute is set on a category, that attribute will be inherited on all products under that category, unless the attribute is set on the product itself.

## Attribute Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller attribute id, auto-generated |
| `name` | string | the name of the attribute. Attribute name can contain any alphanumeric uppercase character and `_`. |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | User friendly attribute identifier. Name is unique per attribute `class`. Can contain any alphanumeric uppercase character and `_`. Cannot be updated after attribute is created. | string |
| `class` | The type of resource for which the attribute will be used. Cannot be updated after attribute is created. Possible values are `product`, `category` , `user`. `user` is used for both users and usergroups resources. | string |
| `isPublic` | Boolean value. Indicates whether attribute will be publicly available or only within Propeller backoffice. | boolean  <br />Default value is `true` |
| `isSearchable` | Boolean value. It is used only for attributes class `product`. Indicates whether attribute values will be indexed and available for searching. | boolean  <br />Default value is `false` |
| `isSystem` | Boolean value. Special custom usage. System attributes are not visible in the resource Attribute tab in Propeller backoffice. | boolean  <br />Default value is `false` |
| `isHidden` | Boolean value. Special custom usage. Hidden attributes are not visible in the resource Attribute tab in Propeller backoffice. Default value is `false`. | boolean  <br />Default value is `false` |
| `type` | Type of the value. Cannot be updated after attribute is created. Possible values are `text`, `list`, `enum`, `enumlist`, `integer`, `decimal`, `date`, `datetime`.  <br />`list` is a multi value attribute with comma delimited list of values.  <br />`enum` is a single value attribute. The possible values are predefined in a valueset.  <br />`enumlist` is a multi-value attribute. The value is a comma delimited list of values predefined in a valueset. | string |
| `typeParam` (string) | Used in combination with type `enum` and `enumlist`. The name of the valueset that holds all possible values. | string |
| `descriptions` | Attribute description/ label. | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `value` | Attribute default value/ resource value. Possible values depend on `type` | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] (`text`, `list`)  <br />string (`enum`, `enumlist`)  <br />integer  <br />decimal  <br />date  <br />datetime |
| `units` | Attribute unit. Ex. use case: If an attribute is a type of measurement like weight or height, the unit will be kg or cm, etc. | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `group` | Attributes are sometimes related to each other. `group` is used to link them. | string  <br />  <br /> |

## Attribute Errors

This section describes error codes specific for the `Attribute` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `14001` | AttributeNotFound | 404 | Attribute does not exist | Attribute with such lookup key already exists |
| `14002` | AttributeMultipleFound | 400 | Multuple attributes found. Please provide additional filters | Multiple attributes with such lookup key found. Provide additional filters |
| `14003` | AttributeExists | 400 | Attribute already exists | Attribute with such `name` already exists |
| `14004` | AttributeInvalidClass | 400 | No attributes defined for class | Attributes for resources of the provided class are not configured |
| `14005` | AttributeInvalidValue | 400 | Invalid value provided | The attribute value does not correspond with the attribute type |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Authentication

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/authentication.tag

<LegacyBanner />



As already described in [Authentication](/reference/legacy/rest-sonar/api-reference#authentication), each request needs a valid `access_token` which once retrieved is valid for 30 minutes.
Use [Get Access Token](/reference/legacy/rest-sonar/get-access-token) request to retrieve a valid `access_token`.



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Bulk attributes by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-attributes-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk attributes by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. Usually, multiple attributes need to be created or updated at the same time which is useful to eliminate a lot of API requests. This endpoint is used for bulk processing of attribute definitions based on an Id.

The `id` field is required and when it is 0 a new attribute will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields `name`, `class` and `type` are ignored.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Gewicht"}}},"example":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":644},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"MATERIAAL_FRAME"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"type":"string","example":""},{"type":"string","example":""}]}}},"example":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","id":644,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":0,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]},"examples":{"Bulk attributes by Id":{"value":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","id":644,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":0,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk attributes by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"531"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:24:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bf682c92-6350-46b1-95ad-f0bb6e6e70d7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"error":{"type":"string","example":"Invalid value provided. Attribute type is [text]."},"id":{"type":"number","example":670},"key":{"type":"number","example":644},"lookupKey":{"type":"string","example":"id"},"message":{"type":"string","example":"Attribute created."},"success":{"type":"boolean","example":false}}},"example":[{"action":"update","error":"Invalid value provided. Attribute type is [text].","key":644,"lookupKey":"id","success":false},{"action":"create","id":670,"key":0,"lookupKey":"id","message":"Attribute created.","success":true},{"action":"update","id":668,"key":668,"lookupKey":"id","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"update","error":"Attribute with id [800] not found.","key":800,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":4}}},"examples":{"Bulk attributes by Id - 200":{"value":{"data":[{"action":"update","error":"Invalid value provided. Attribute type is [text].","key":644,"lookupKey":"id","success":false},{"action":"create","id":670,"key":0,"lookupKey":"id","message":"Attribute created.","success":true},{"action":"update","id":668,"key":668,"lookupKey":"id","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"update","error":"Attribute with id [800] not found.","key":800,"lookupKey":"id","success":false}],"messages":["Completed"],"total":4}}}}}},"400":{"description":"Bulk attributes by Id - 400 (missing name)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"799"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:26:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"49c7211c-0ed0-45a6-92ac-976d2f34f874"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/0: required key [name] not found"},"example":["#/0: required key [name] not found","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: JSONArray, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk attributes by Id - 400 (missing name)":{"value":{"error":{"code":10007,"messages":["#/0: required key [name] not found","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: JSONArray, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk attributes by name

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-attributes-by-name.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk attributes by name"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/bulk/name"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. Usually, multiple attributes need to be created or updated at the same time which is useful to eliminate a lot of API requests. This endpoint is used for bulk processing of attribute definitions based on the name.

The `name` field is required and if an attribute with the provided `name` and `class` is not found it will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields `name`, `class` and `type` are ignored.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Gewicht"}}},"example":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"WEIGHT"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"string","example":"2022-12-013"},{"type":"string","example":""}]}}},"example":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"PROMOTION_DATE","type":"date","typeParam":"","value":"2022-12-013"},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]},"examples":{"Bulk attributes by name":{"value":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"PROMOTION_DATE","type":"date","typeParam":"","value":"2022-12-013"},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk attributes by name - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"484"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:28:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bfd7ccaf-175e-4ab4-9ad2-4eca483271a5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":661},"key":{"type":"string","example":"WEIGHT"},"lookupKey":{"type":"string","example":"name"},"message":{"type":"string","example":"Attribute updated. Fields 'name', 'type' and 'class' are not updated."},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"create","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute created.","success":true},{"action":"update","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk attributes by name - 200":{"value":{"data":[{"action":"update","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"create","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute created.","success":true},{"action":"update","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk attributes by name - 400 (invalid date)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"790"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:32:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8c5a3a61-ac6d-4e23-a893-4389a10a778f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/1/type: date is not a valid enum value"},"example":["#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/1/type: date is not a valid enum value","#/1/value: expected type: JSONArray, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Integer, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Number, found: String","#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk attributes by name - 400 (invalid date)":{"value":{"error":{"code":10007,"messages":["#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/1/type: date is not a valid enum value","#/1/value: expected type: JSONArray, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Integer, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Number, found: String","#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Categories by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-categories-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Categories by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/categories#category-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | yes |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/categories#category-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1800},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescription":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"GPS"}}},"example":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]}}},"example":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1800,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"id":1850,"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"id":1900,"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"id":1320},"shortDescription":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Categories by Id":{"value":{"categories":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1800,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"id":1850,"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"id":1900,"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"id":1320},"shortDescription":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Categories by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"264"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:54:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1c6c3576-f661-472d-a29c-5a6c70da3ea7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":1781},"key":{"type":"number","example":1800},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":1781,"key":1800,"lookupKey":"id","success":true},{"action":"create","id":1783,"key":1850,"lookupKey":"id","success":true},{"action":"create","id":1785,"key":1900,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Categories by Id - 200":{"value":{"data":[{"action":"create","id":1781,"key":1800,"lookupKey":"id","success":true},{"action":"create","id":1783,"key":1850,"lookupKey":"id","success":true},{"action":"create","id":1785,"key":1900,"lookupKey":"id","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk Categories by Id - 400 (Invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"209"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:55:20 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f5d789ba-70e2-437a-ae41-3294e2a93615"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/categories/2: extraneous key [shortDescription] is not permitted"},"example":["#/categories/2: extraneous key [shortDescription] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Categories by Id - 400 (Invalid schema)":{"value":{"error":{"code":10007,"messages":["#/categories/2: extraneous key [shortDescription] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Categories by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-categories-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Categories by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source` and `language`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/categories#category-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | yes |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/categories#category-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"language":{"type":"string","example":"NL"},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Accessoires"}}},"example":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},"parent":{"type":"object","properties":{"sourceId":{"type":"string","example":"136045"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"011000"}}},"example":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"011000"},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"source":"REST-API","sourceId":"020000"},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"source":"REST-API","sourceId":"020100"}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Categories by sourceId":{"value":{"categories":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"011000"},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"source":"REST-API","sourceId":"020000"},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"source":"REST-API","sourceId":"020100"}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Categories by sourceId - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"294"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:48:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1997ac78-f73f-4729-aa4b-e7b70dd25238"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":1779},"key":{"type":"string","example":"011000"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":1779,"key":"011000","lookupKey":"sourceId","success":true},{"action":"update","id":1775,"key":"020000","lookupKey":"sourceId","success":true},{"action":"update","id":1777,"key":"020100","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Categories by sourceId - 200":{"value":{"data":[{"action":"create","id":1779,"key":"011000","lookupKey":"sourceId","success":true},{"action":"update","id":1775,"key":"020000","lookupKey":"sourceId","success":true},{"action":"update","id":1777,"key":"020100","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk Categories by sourceId - 400 (Invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"246"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:49:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1ddad22b-3864-4d9a-ac78-1b4b38a77b64"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/categories/0: required key [names] not found"},"example":["#/categories/0: required key [names] not found","#/categories/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Categories by sourceId - 400 (Invalid schema)":{"value":{"error":{"code":10007,"messages":["#/categories/0: required key [names] not found","#/categories/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Cluster Options by lookupKey

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-cluster-options-by-lookupkey.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Cluster Options by lookupKey"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk `id` endpoint, the options are identified by Propeller option `id`. If an option with such `id` doesn't already exist, it will be created. If it does exist, the option will be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `isRequired` | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing option that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing option in the parent cluster provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for an option that are not provided in the payload | empty array |
| `skipCreate` | Do not create new options, only update existing | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"COFYR88"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"}]},"options":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"example":[{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},{"descriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"source":"REST-API","sourceId":"KM636000"}]}}},"examples":{"Bulk Cluster Options by lookupKey":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"}],"options":[{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},{"descriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"source":"REST-API","sourceId":"KM636000"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Cluster Options by lookupKey - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"214"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:51:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a508dfec-5778-407d-93b2-3fb7b7c6ccd8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":214},"key":{"type":"string","example":"K72334000"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":214,"key":"K72334000","lookupKey":"sourceId","success":true},{"action":"create","id":216,"key":"KM636000","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Cluster Options by lookupKey - 200":{"value":{"data":[{"action":"update","id":214,"key":"K72334000","lookupKey":"sourceId","success":true},{"action":"create","id":216,"key":"KM636000","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"404":{"description":"Bulk Cluster Options by lookupKey - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:52:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b332a11c-c599-499e-a1d5-cee87c72d8dc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with sourceId [COFYR8800] not found"},"example":["Parent Cluster with sourceId [COFYR8800] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Bulk Cluster Options by lookupKey - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with sourceId [COFYR8800] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Cluster Products by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-cluster-products-by-sourceid.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Cluster Products by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of cluster products with just a single API call. The same lookup key is used for the products as for the cluster. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/clusters#cluster-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/attributes)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"15120300"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"name":{"type":"string","example":"PROPELLER_COLOR"},"type":{"type":"string","example":"text"},"value":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"zwart"}}},"example":[{"language":"NL","value":"zwart"}]}}},"example":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}]},"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044006"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra zwart"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra zwart"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"zwart"}}},"example":[{"language":"NL","value":"zwart"}]},"oemCode":{"type":"string","example":"151201"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra zwart"},"sku":{"type":"string","example":"151201"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151201"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151201"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044006","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra zwart"}],"notes":[{"language":"NL","value":"zwart"}],"oemCode":"151201","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra zwart","sku":"151201","source":"REST-API","sourceId":"151201","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151201","taxCode":"H","unit":1},{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"groen"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675054708","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra groen"}],"notes":[{"language":"NL","value":"groen"}],"oemCode":"151204","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra groen","sku":"151204","source":"REST-API","sourceId":"151204","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151204","taxCode":"H","unit":1}]}}},"examples":{"Bulk Cluster Products by sourceId":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044006","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra zwart"}],"notes":[{"language":"NL","value":"zwart"}],"oemCode":"151201","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra zwart","sku":"151201","source":"REST-API","sourceId":"151201","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151201","taxCode":"H","unit":1},{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"groen"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675054708","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra groen"}],"notes":[{"language":"NL","value":"groen"}],"oemCode":"151204","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra groen","sku":"151204","source":"REST-API","sourceId":"151204","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151204","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Cluster Products by sourceId - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"215"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:55:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e234dcc7-892c-40cd-a801-ca6645469424"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":707969},"key":{"type":"string","example":"151201"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":707969,"key":"151201","lookupKey":"sourceId","success":true},{"action":"create","id":707970,"key":"151204","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Cluster Products by sourceId - 200":{"value":{"data":[{"action":"create","id":707969,"key":"151201","lookupKey":"sourceId","success":true},{"action":"create","id":707970,"key":"151204","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"404":{"description":"Bulk Cluster Products by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:56:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b022ca1b-c01b-4706-a31f-1f2e80c6b9ea"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with sourceId [15120300111] not found"},"example":["Parent Cluster with sourceId [15120300111] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Bulk Cluster Products by sourceId - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with sourceId [15120300111] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Clusters by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-clusters-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Clusters by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/clusters#cluster-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | yes |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/attributes)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":9},"code":{"type":"string","example":"030004"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Cluster 5"}}},"example":[{"language":"EN","value":"Cluster 5"}]},"id":{"type":"number","example":700},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Cluster 6"}}},"example":[{"language":"EN","value":"Cluster 6"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}}}},"example":[{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 5"}],"id":700,"names":[{"language":"EN","value":"Cluster 6"}],"parent":{"id":23409}},{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 6"}],"id":701,"names":[{"language":"EN","value":"Cluster 7"}],"parent":{"id":23409}}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Clusters by Id":{"value":{"clusters":[{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 5"}],"id":700,"names":[{"language":"EN","value":"Cluster 6"}],"parent":{"id":23409}},{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 6"}],"id":701,"names":[{"language":"EN","value":"Cluster 7"}],"parent":{"id":23409}}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Bulk Clusters by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-clusters-by-sourceid.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Clusters by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source` and `language`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/clusters#cluster-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | yes |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/attributes)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"examples":{"Bulk Clusters by sourceId":{"value":{"clusters":[{"clusterConfigId":9,"language":"NL","sourceId":"030333335","source":"RESTAPI","names":[{"language":"NL","value":"Cluster 5"}],"code":"030004","parent":{"sourceId":"CLUSTERS"},"descriptions":[{"language":"NL","value":"Cluster 5"}],"options":[{"names":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"language":"NL","sourceId":"030997","source":"RESTAPI","descriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"shortDescriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"isRequired":true},{"names":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"language":"NL","sourceId":"030998","source":"RESTAPI","descriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"shortDescriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"isRequired":false}],"products":[{"language":"NL","names":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"sku":"NCABD70888","status":"A","descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br>De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br>Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"shortName":"Edge 1030 Fietscomputer","shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"supplier":"TECHDATA","supplierCode":"NCABD70004","oemCode":"NCABD70004","eanCode":"0753759256289","taxCode":"H","price":599.95,"unit":1,"minimumQuantity":1,"manufacturer":"Garmin","costPrice":400.95,"suggestedPrice":580,"package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"notes":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"source":"TECHDATA","sourceId":"NCABD7011114"},{"language":"NL","names":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"sku":"NCABD70004","status":"A","descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br>De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br>Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"shortName":"Edge 1030 Fietscomputer","shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"supplier":"TECHDATA","supplierCode":"NCABD70004","oemCode":"NCABD70004","eanCode":"0753759256289","taxCode":"H","price":599.95,"unit":1,"minimumQuantity":1,"manufacturer":"Garmin","costPrice":400.95,"suggestedPrice":580,"package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"notes":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"source":"TECHDATA","sourceId":"NCABD7022225"}]},{"clusterConfigId":9,"language":"NL","sourceId":"030777","source":"RESTAPI","names":[{"language":"NL","value":"Cluster 6"}],"code":"030004","parent":{"sourceId":"CLUSTERS"},"descriptions":[{"language":"NL","value":"Cluster 6"}]}],"directives":[{"operation":"skipIfNotEmpty","fields":["names","descriptions"]},{"operation":"skipMoveOnUpdate","fields":[]},{"operation":"mergeTranslationsOnUpdate","fields":[]}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Bulk Inventory by lookup key / inventory type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-inventory-by-lookup-key-inventory-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Inventory by lookup key / inventory type"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/{lookupKey}/{inventoryType}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk inventory endpoint is used to create or update inventory records. The products can be identified based on one of their lookup keys. The inventory record type can be either `local` or `supplier`.

When looking up an inventory record, the matching fields are: `lookupKey`, `warehouseId` and `location`. If a record already exists it will be updated, otherwise a new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `sku` (string) | only when lookup key is `sku` |
| `supplierCode` (string) | only when lookup key is `supplierCode` |
| `supplier` (string) | only when lookup key is `supplierCode` |
| `id` (integer) | only when lookup key is `id` |
| `sourceId` (string) | only when lookup key is `sourceId` |
| `source` (string) | only when lookup key is `sourceId` |
| `language` (string) | only when lookup key is `sourceId` |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"inventoryType","in":"path","required":true,"schema":{"type":"string","example":"supplier"},"description":"Inventory type. `local` or `supplier`"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"company":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TESTSOURCE"},"sourceId":{"type":"number","example":1}}},"language":{"type":"string","example":"NL"},"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-03-01 00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":77},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143111}}}}},"example":[{"language":"NL","location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":77,"source":"TECHDATA","sourceId":"NCABD70004","usergroup":{"id":143111}},{"company":{"language":"NL","source":"TESTSOURCE","sourceId":1},"language":"NL","quantity":87,"source":"TECHDATA","sourceId":"NCABD70004"}]}}},"examples":{"Bulk Inventory by lookup key / inventory type":{"value":{"inventory":[{"language":"NL","location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":77,"source":"TECHDATA","sourceId":"NCABD70004","usergroup":{"id":143111}},{"company":{"language":"NL","source":"TESTSOURCE","sourceId":1},"language":"NL","quantity":87,"source":"TECHDATA","sourceId":"NCABD70004"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk supplier inventory by source id - 200 / Bulk local inventory by sourceId - 200 / Bulk supplier inventory by supplier code - 200 / Bulk local inventory by sku - 200 / Bulk local inventory by Id - 200 / Bulk supplier inventory by source id for company and usergroup - 200 / Bulk supplier inventory by source id for company and non existing usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"178"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 19:36:04 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":16134},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":16134,"success":true},{"action":"update","id":16135,"success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk local inventory by Id - 200":{"value":{"data":[{"action":"update","id":16131,"success":true},{"action":"create","id":16138,"success":true}],"messages":["Completed"],"total":2}},"Bulk local inventory by sku - 200":{"value":{"data":[{"action":"update","id":16131,"success":true},{"action":"update","id":16132,"success":true}],"messages":["Completed"],"total":2}},"Bulk local inventory by sourceId - 200":{"value":{"data":[{"action":"create","id":16136,"success":true},{"action":"create","id":16137,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id - 200":{"value":{"data":[{"action":"update","id":16134,"success":true},{"action":"update","id":16135,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id for company and non existing usergroup - 200":{"value":{"data":[{"action":"create","message":"Usergroup with id [143111] not found","success":false},{"action":"update","id":16139,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id for company and usergroup - 200":{"value":{"data":[{"action":"update","id":16141,"success":true},{"action":"update","id":16139,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by supplier code - 200":{"value":{"data":[{"action":"create","message":"Product with supplierCode [757540] not found","success":false},{"action":"update","id":16125,"success":true},{"action":"update","id":16126,"success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk supplier inventory by source id - 400 (invalid inventory type) / Bulk supplier inventory by sourceId - 400 (invalid lookup key)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"242"}},"Date":{"schema":{"type":"string","example":"Mon, 29 Aug 2022 21:24:02 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13007},"messages":{"type":"array","items":{"type":"string","example":"Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"},"example":["Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidInventoryType"}}}}},"examples":{"Bulk supplier inventory by source id - 400 (invalid inventory type)":{"value":{"error":{"code":13007,"messages":["Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"],"moreInfo":"https://www.propel.us/docs/errors/13007","status":400,"type":"InvalidInventoryType"}}},"Bulk supplier inventory by sourceId - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [sourceIds], key must contain one of the following values: [id,sourceId,sku,suppliercode]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Links by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-links-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Links by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/links/bulk/{lookupKey}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of links with just a single API call. When using the bulk `id` endpoint, the link resources are identified by Propeller `id`. If a link for resources with such `id` doesn't already exist, it will be created. If it does exist, it will be updated.

When using the bulk `sourceId` endpoint, the link resources are identified by Propeller `sourceId` and `source`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `subtype` | yes |
| `isDefault` | no  <br />Defaults to `false` |
| `isActive` | no  <br />Defaults to `true` |
| `from` | yes |
| `to` | yes  <br /> |
| `priority` | no  <br />Default to 0 |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD7000411"}}},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"subtype":{"type":"string","example":"normal"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"}}},"type":{"type":"string","example":"accessories-dummy"}}},"example":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"},"type":"accessories-dummy"},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"},"type":"alternatives"}]}}},"examples":{"Bulk Links by lookup key":{"value":{"links":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"},"type":"accessories-dummy"},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"},"type":"alternatives"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Links by Id - 200 / Bulk Links by Id - 200 (Product cross/upsell use case) / Bulk Links by sourceId - 200 (Product cross/upsell use case)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"502"}},"Date":{"schema":{"type":"string","example":"Fri, 14 Jul 2023 14:08:51 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","example":"Customer with id [19815] not found"},"from":{"type":"object","properties":{"class":{"type":"string","example":"customer"},"id":{"type":"number","example":19815}}},"id":{"type":"number","example":543843},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":false},"to":{"type":"object","properties":{"class":{"type":"string","example":"company"},"id":{"type":"number","example":204}}}}},"example":[{"error":"Customer with id [19815] not found","from":{"class":"customer","id":19815},"lookupKey":"id","success":false,"to":{"class":"company","id":204}},{"from":{"class":"contact","id":14575},"id":543843,"lookupKey":"id","success":true,"to":{"class":"company","id":150}}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Links by Id - 200":{"value":{"data":[{"error":"Customer with id [19815] not found","from":{"class":"customer","id":19815},"lookupKey":"id","success":false,"to":{"class":"company","id":204}},{"from":{"class":"contact","id":14575},"id":543843,"lookupKey":"id","success":true,"to":{"class":"company","id":150}}],"messages":["Completed"],"total":2}},"Bulk Links by Id - 200 (Product cross/upsell use case)":{"value":{"data":[{"from":{"class":"product","id":227293},"id":543973,"lookupKey":"id","success":true,"to":{"class":"product","id":227294}},{"from":{"class":"product","id":227293},"id":543974,"lookupKey":"id","success":true,"to":{"class":"product","id":227292}}],"messages":["Completed"],"total":2}},"Bulk Links by sourceId - 200 (Product cross/upsell use case)":{"value":{"data":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"id":543975,"lookupKey":"sourceId","success":true,"to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"}},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"id":543976,"lookupKey":"sourceId","success":true,"to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"}}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Links by lookup key - 400 (invalid lookup key) / Bulk Links by sourceId - 400 (schema validation error)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"202"}},"Date":{"schema":{"type":"string","example":"Fri, 14 Jul 2023 14:10:45 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Bulk Links by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}},"Bulk Links by sourceId - 400 (schema validation error)":{"value":{"error":{"code":10007,"messages":["#/links/0/type: accessories-dummy is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Local Inventory (deprecated)

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-local-inventory-deprecated.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Local Inventory (deprecated)"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk local inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of `Bulk Inventory by lookup key / inventory type` where you can use the same payload, but you need to set the lookup key param to `sku` and the inventory type param to `local`.

On creating a record, inventory type **local** is matching the product on the field **sku**. If the product is found, inventory record will be created.

For updating a record, matching fields are: **sku**, **warehouseId** and **location**. Record is updated only when inventory record with all three matching fields is found, otherwise new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `sku` (string) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-03-01T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":13},"sku":{"type":"string","example":"AA 0635613"},"warehouseId":{"type":"number","example":2}}},"example":[{"quantity":13,"sku":"AA 0635613"},{"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","quantity":3,"sku":"757540","warehouseId":2}]}}},"examples":{"Bulk Local Inventory (deprecated)":{"value":{"inventory":[{"quantity":13,"sku":"AA 0635613"},{"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","quantity":3,"sku":"757540","warehouseId":2}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Local Inventory - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"117"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:49:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2bcc0c26-613c-4e37-b317-d472031a42d4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","success":true},{"action":"update","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Local Inventory - 200":{"value":{"data":[{"action":"update","success":true},{"action":"update","success":true}],"messages":["Completed"],"total":2}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Product by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-product-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Product by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/products#product-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/products#product-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"name":{"type":"string","example":"PROPELLOR_LABEL_1"},"type":{"type":"string","example":"text"},"value":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"FietsComputer"}}},"example":[{"language":"NL","value":"FietsComputer"}]}}},"example":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}]},"brand":{"type":"string","example":"Garmin"},"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40366},"language":{"type":"string","example":"NL"},"minimumQuantity":{"type":"number","example":1},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"attributes":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}],"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40366,"language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","id":40368,"language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}},"examples":{"Bulk Product by Id":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"attributes":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}],"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40366,"language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","id":40368,"language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:31:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a3b9ed62-8e3b-4461-a35c-10b6d93dafce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":40366},"key":{"type":"number","example":0},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":40366,"key":0,"lookupKey":"id","success":true},{"action":"create","id":40368,"key":48118,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Product by Id - 200":{"value":{"data":[{"action":"create","id":40366,"key":0,"lookupKey":"id","success":true},{"action":"create","id":40368,"key":48118,"lookupKey":"id","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Product by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:34:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"753ccea0-3d08-4a73-af3c-3333c94ff61c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/products/0: required key [names] not found"},"example":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Product by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Product by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-product-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Product by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `sourceId` endpoint, the products are identified by `sourceId`, `source` and `language`. If a product doesn't already exist, it will be created. If it does exist, the product found will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/products#product-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `parent` | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-sonar/products#product-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string","example":"Garmin"},"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"language":{"type":"string","example":"NL"},"minimumQuantity":{"type":"number","example":1},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020100"}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","source":"TECHDATA","sourceId":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}},"examples":{"Bulk Product by source id":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","source":"TECHDATA","sourceId":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Product by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"221"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:26:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"db53b21e-a47d-45d8-a561-5bc661d5d06b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":40362},"key":{"type":"string","example":"NCABD70004"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":40362,"key":"NCABD70004","lookupKey":"sourceId","success":true},{"action":"create","id":40364,"key":"NCABD70005","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Product by source id - 200":{"value":{"data":[{"action":"create","id":40362,"key":"NCABD70004","lookupKey":"sourceId","success":true},{"action":"create","id":40364,"key":"NCABD70005","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Product by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:28:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"59b15fa3-b7ef-4397-9991-b861daf5962a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/products/0: required key [names] not found"},"example":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Product by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk resource attribute values by resource lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-resource-attribute-values-by-resource-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk resource attribute values by resource lookup key"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk resource attribute endpoint sets/ deletes resource attributes for a single resource identified by the [lookup key](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys). The attribute is identified via the payload by providing either `id` or `name`. If both are provided, `id` will be used to identify the attribute. Below is a summary of all the possible fields in the payload.

## Fields

| **Name** | **Required** |
| --- | --- |
| `id` | yes, if `name` not provided |
| `name` | yes, if `id` not specified |
| `class` | yes, if `id` not specified |
| `type` | yes |
| `value` | no, if omitted the attribute value will be deleted for the resource (set to default) |

A successful response contains data about each attribute changes: whether the attribute was created/ updated for that resource, in which case the `action` in the response will be `put`, or `delete` if the value of the attribute for the particular resource is being deleted. After it is deleted, the attribute value for the specific resource will inherit the value from the parent resource(s).

In case of an issue, the data will contain a message explaining the reason, for ex. when an attribute is not found, or the value provided does not match the attribute type, etc.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_REKENING"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"Y"}}},"example":[{"class":"user","name":"SHOW_REKENING","type":"enum","value":"Y"}]},"examples":{"Bulk resource attribute values by resource lookup key":{"value":[{"class":"user","name":"SHOW_REKENING","type":"enum","value":"Y"}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk product attribute values by product id - 200 / Bulk product attribute values by product source id - 200 / Bulk user attribute values by user id and attribute name - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 11:47:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"86561cda-74b1-44a5-bc18-7a0c6b71c7b3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"put"},"error":{"type":"string","example":"Attribute with name [HEIGHT] not found."},"id":{"type":"number","example":661},"key":{"type":"string","example":"WEIGHT"},"lookupKey":{"type":"string","example":"name"},"message":{"type":"string","example":"Attribute value put."},"success":{"type":"boolean","example":true},"value":{"example":15,"anyOf":[{"type":"number","example":15},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Leer"}}},"example":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]}]}}},"example":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":4}}},"examples":{"Bulk product attribute values by product id - 200":{"value":{"data":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}],"messages":["Completed"],"total":4}},"Bulk product attribute values by product source id - 200":{"value":{"data":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}],"messages":["Completed"],"total":4}},"Bulk user attribute values by user id and attribute name - 200":{"value":{"data":[{"action":"put","id":48,"key":"SHOW_REKENING","lookupKey":"name","message":"Attribute value put.","success":true,"value":"Y"}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk product attribute values by product id - 400 (schema validation error)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"636"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 13:51:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0414e304-7170-4878-ab25-c744c595cd6a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/0/type: decimal is not a valid enum value"},"example":["#/0/type: decimal is not a valid enum value","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: Integer, found: JSONArray","#/0/value: expected type: Number, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk product attribute values by product id - 400 (schema validation error)":{"value":{"error":{"code":10007,"messages":["#/0/type: decimal is not a valid enum value","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: Integer, found: JSONArray","#/0/value: expected type: Number, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk product attribute values by product id - 404 / Bulk product attribute values by product source id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 14:26:10 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"68df5e8c-6053-45d1-9b00-3c9e88bfdd33"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10009},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Product] with id [372212] not found."},"example":["Parent resource [Product] with id [372212] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10009"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentProductNotFound"}}}}},"examples":{"Bulk product attribute values by product id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with id [372212] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}},"Bulk product attribute values by product source id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with sourceId [076548] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Supplier Inventory (deprecated)

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-supplier-inventory-deprecated.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Supplier Inventory (deprecated)"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk supplier inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of `Bulk Inventory by lookup key / inventory type` where you can use the same payload, but you need to set the lookup key param to `supplierCode` and the inventory type param to `supplier`.

On creating a record, inventory type **supplier** is matching the product on two fields: **supplier** and **supplierCode**. If the product is found, inventory record will be created.

For updating a record, matching fields are: **supplier**, **supplierCode**, **warehouseId** and **location**. Record is updated only when inventory record with all four matching fields is found, otherwise new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `supplier` (string) | yes |
| `supplierCode` (string) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-02-25T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":15},"supplier":{"type":"string","example":"QUANTORE"},"supplierCode":{"type":"string","example":"757540"},"warehouseId":{"type":"number","example":4}}},"example":[{"nextDeliveryDate":"2021-02-25T00:00:00","notes":"","quantity":15,"supplier":"QUANTORE","supplierCode":"757540","warehouseId":4},{"location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":3,"supplier":"QUANTORE","supplierCode":"851071","warehouseId":2},{"quantity":5,"supplier":"KERRIDGE","supplierCode":"AA 0635613"}]}}},"examples":{"Bulk Supplier Inventory (deprecated)":{"value":{"inventory":[{"nextDeliveryDate":"2021-02-25T00:00:00","notes":"","quantity":15,"supplier":"QUANTORE","supplierCode":"757540","warehouseId":4},{"location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":3,"supplier":"QUANTORE","supplierCode":"851071","warehouseId":2},{"quantity":5,"supplier":"KERRIDGE","supplierCode":"AA 0635613"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Supplier Inventory - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"152"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:46:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a390db21-cbe8-456d-acc8-ce487d9176fe"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","success":true},{"action":"create","success":true},{"action":"update","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Supplier Inventory - 200":{"value":{"data":[{"action":"update","success":true},{"action":"create","success":true},{"action":"update","success":true}],"messages":["Completed"],"total":3}}}}}}}}
>
  
</StatusCodes>

---

## Bulk User Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-user-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk User Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple user addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Bulk User Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bulk User Addresses - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Bulk User Addresses - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Bulk User Addresses - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk User Addresses - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk User Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Bulk User Addresses - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroup Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-usergroup-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroup Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple usergroup addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Bulk Usergroup Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bulk Usergroup Addresses - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroup Addresses - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Bulk Usergroup Addresses - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroup Addresses - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk Usergroup Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Bulk Usergroup Addresses - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroups by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-usergroups-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroups by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `id` endpoint, the usergroups are identified by `id`. If a usergroup with such `id` doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go [here](/reference/legacy/rest-sonar/pricesheets).

A single usergroup's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/usergroups#usergroup-lookup-keys), but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `usergroups` (array of usergroup objects) | yes |
| `id` | yes |
| `name` | no |
| `language` | no |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-sonar/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing usergroup that are not empty | array of field names  <br />e.g. name, company etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing usergroup in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]},"usergroups":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":250},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":214}}}}},"example":[{"budget":"N","budgetInherit":"N","company":"","department":"","id":250,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","notes":"Usergroup created from API","office":"","parent":{"id":214}}]}}},"examples":{"Bulk Usergroups by Id":{"value":{"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}],"usergroups":[{"budget":"N","budgetInherit":"N","company":"","department":"","id":250,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","notes":"Usergroup created from API","office":"","parent":{"id":214}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Usergroups by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:44:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9acb5f95-5bfb-4ed9-8a3b-e32c980eb1ce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":215},"key":{"type":"number","example":250},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":215,"key":250,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroups by Id - 200":{"value":{"data":[{"action":"create","id":215,"key":250,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Usergroups by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:05:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c7e8e727-9ea6-463b-8323-1107f2da55a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/usergroups/0: required key [name] not found"},"example":["#/usergroups/0: required key [name] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroups by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/usergroups/0: required key [name] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroups by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-usergroups-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroups by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `sourceId` endpoint, the usergroups are identified by `sourceId`, `source` and `language`. If a usergroup doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go [here](/reference/legacy/rest-sonar/pricesheets).

A single usergroup's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/users#user-lookup-keys), but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `usergroups` (array of usergroup objects) | yes |
| `source` | yes |
| `sourceId` | yes |
| `name` | no |
| `language` | yes |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-sonar/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing usergroup that are not empty | array of field names  <br />e.g. name, company etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing usergroup in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]},"usergroups":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}}}},"example":[{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":109}}]}}},"examples":{"Bulk Usergroups by source id":{"value":{"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}],"usergroups":[{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":109}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Usergroups by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"179"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 11:02:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e3e4243-b81d-4fe7-9566-b6844a18daa1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":215},"key":{"type":"number","example":100001},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":215,"key":100001,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroups by source id - 200":{"value":{"data":[{"action":"update","id":215,"key":100001,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Usergroups by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"238"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 11:00:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7aaae2c3-1615-40de-8b9d-9fb94a108d4f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/usergroups/0: required key [sourceId] not found"},"example":["#/usergroups/0: required key [sourceId] not found","#/usergroups/0: required key [id] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroups by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/usergroups/0: required key [sourceId] not found","#/usergroups/0: required key [id] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Users by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-users-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Users by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `id` endpoint, the products are identified by `id`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go [here](/reference/legacy/rest-sonar/pricesheets).

A single users attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/users#user-lookup-keys), but if it's needed to modify attributes for multiple users, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `users` (array of users) | yes |
| `id` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-sonar/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14718},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"id":{"type":"number","example":122}}},"phone":{"type":"string","example":"0032445888"},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","gender":"M","id":14718,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":122},"phone":"0032445888","title":"Mr."}]}}},"examples":{"Bulk Users by Id":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","gender":"M","id":14718,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":122},"phone":"0032445888","title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Users by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:44:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9acb5f95-5bfb-4ed9-8a3b-e32c980eb1ce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":14713},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Users by Id - 200":{"value":{"data":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Users by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:05:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c7e8e727-9ea6-463b-8323-1107f2da55a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/users/0: required key [firstName] not found"},"example":["#/users/0: required key [firstName] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Users by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/users/0: required key [firstName] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Users by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/bulk-users-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Users by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `sourceId` endpoint, the users are identified by `sourceId`, `source` and `language`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go [here](/reference/legacy/rest-sonar/attributes).

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go [here](/reference/legacy/rest-sonar/pricesheets).

A single users attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-sonar/users#user-lookup-keys), but if it's needed to modify attributes for multiple users, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `users` (array of users) | yes |
| `source` | yes |
| `sourceId` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-sonar/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-sonar/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":200105}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}},"examples":{"Bulk Users by source id":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}},"Search Users":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Users by source id - 200 / Bulk Users by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:39:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"19ec74a0-4079-44b6-ab3b-8ca4d325e268"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":14713},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Users by source id - 200":{"value":{"data":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Users by source id - 400 (invalid schema) / Bulk Users by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 17:59:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"04c2dbfb-985e-4a58-8794-957974360a32"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/users/0: required key [firstName] not found"},"example":["#/users/0: required key [firstName] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Users by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/users/0: required key [firstName] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Categories

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/categories.tag

<LegacyBanner />



Categories are used in order to organize your product catalogue within your e-commerce platform. They work as hierarchical levels of product classification. There are no limits to the number of levels of categories, though it is recommended not to use too many levels. One product can belong to only one category. The same applies to categories, a category can have only one parent category.

## Category Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller category id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `names` | Category name | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `descriptions` | Category description | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `shortDescriptions` | Category short description | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `language` | Category default language. | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent category. | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Category Errors

This section describes error codes specific for the `Category` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `30004` | CategoryExists | 400 | Category already exists | Category with such lookup key already exists |
| `30005` | CategoryMultipleFound | 400 | Multuple categories found. Please provide additional filters | Multiple categories with such lookup key exist |
| `30006` | CategoryNotFound | 404 | Category does not exist | Category with such lookup key not found |
| `30007` | ParentCategoryNotFound | 404 | Parent category not found | Parent category with such lookup key not found. This error is typical when working with category sub-resources (e.g. attributes) |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/cluster-config.tag

<LegacyBanner />



Cluster configs are used as rules on how to organize and group your products into clusters within your e-commerce platform. There can be normal clusters for example where there is no need to define attribute, but there can be linear or complex clusters, where you need to define one or two attributes that will be used to group the products.

## Cluster Config Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller cluster config id, auto-generated |
| `name` | string | Cluster config name |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | Cluster config name | string (only alphanumeric characters combined with underscore) |
| `settings` | Cluster config settings | array |

## Settings

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `attributeName` | Setting attribute name | string |
| `displayType` | Setting display type | enum  <br />\- dropdown  <br />\- radio  <br />\- image  <br />\- color |
| `priority` | Setting priority | integer |

## Cluster Config Errors

This section describes error codes specific for the `ClusterConfig` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `21004` | ClusterConfigExists | 400 | Cluster Config already exists | Cluster config with such name already exists |
| `21005` | ClusterConfigNotFound | 404 | Cluster Config does not exist | Cluster config with such lookup key not found |
| `21006` | ClusterConfigSettingExists | 400 | Cluster Config Setting already exists | Cluster config setting with such attribute name already exists |
| `21007` | ClusterConfigSettingNotFound | 404 | Cluster Config Setting does not exist | Cluster config setting with such lookup key not found |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Clusters

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/clusters.tag

<LegacyBanner />



Clusters are groups of products and/or options in an e-commerce shop on the Propeller platform. The Cluster API can be used to consult, create, update or delete a Cluster, Cluster Option or Cluster Product.

## Cluster Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller cluster id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `clusterConfigId` | Cluster config id | integer |
| `sourceId` | External system unique id | string |
| `source` | External system | string |
| `language` | Cluster default language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `code` | Cluster code | string |
| `names` | Cluster name | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `descriptions` | Cluster description | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `shortDescriptions` | Cluster short description | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `parent` | Parent category | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |

## Cluster Errors

This section describes error codes specific for the `Cluster` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `20004` | ClusterExists | 400 | Cluster already exists | Cluster with such lookup key already exists |
| `20005` | ClusterMultipleFound | 400 | Multiple clusters found. Please provide additional filters | Multiple clusters with such lookup key exist |
| `20006` | ClusterNotFound | 404 | Cluster does not exist | Cluster with such lookup key not found |
| `20007` | ParentClusterNotFound | 404 | Parent cluster not found | Parent cluster with such lookup key not found. |
| `20008` | ClusterNotAllowed | 405 | Cluster is not allowed | No permission for the cluster |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Create attribute

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-attribute.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create attribute"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. This endpoint is used to create a single attribute definition.

If an attribute is successfully created, the response will include the attribute `id.`

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | yes |
| `class` | yes |
| `isPublic` | no  <br />Default value is `true` |
| `isSearchable` | no  <br />Default value is `false` |
| `isSystem` | no  <br />Default value is `false` |
| `isHidden` | no  <br />Default value is `false` |
| `type` | yes |
| `typeParam` | only when `type` value is `enum` or `enumlist` |
| `descriptions` | no |
| `value` | only when `type` is `integer`, `decimal`, `date` or `datetime` |
| `units` | no |
| `group` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"value":{"type":"string","example":""}}},"examples":{"Create attribute":{"value":{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create product enum attribute - 201 / Create product text attribute - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"389"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:11:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"02996d01-6320-4efc-bdb4-808e3841ab8c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"value":{"example":"","anyOf":[{"type":"string","example":""},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""},{"language":"EN","value":""}]}]}}},"messages":{"type":"array","items":{"type":"string","example":"Attribute created"},"example":["Attribute created"]},"total":{"type":"number","example":1}}},"examples":{"Create product enum attribute - 201":{"value":{"data":{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},"messages":["Attribute created"],"total":1}},"Create product text attribute - 201":{"value":{"data":{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":669,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},"messages":["Attribute created"],"total":1}}}}}},"400":{"description":"Create product text attribute - 400 (invalid value) / Create product enum attribute - 400 (duplicate name)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:13:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a7b7ccff-f72e-49cd-aec2-f3e946dbf060"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/type: text is not a valid enum value"},"example":["#/type: text is not a valid enum value","#/value: expected type: JSONArray, found: String","#/type: text is not a valid enum value","#/value: expected type: Integer, found: String","#/type: text is not a valid enum value","#/value: expected type: Number, found: String","#/type: text is not a valid enum value","#/value: string [] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/type: text is not a valid enum value","#/value: string [] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create product enum attribute - 400 (duplicate name)":{"value":{"error":{"code":14003,"messages":["Attribute with name [COLOR] already exists."],"moreInfo":"https://www.propel.us/docs/errors/14003","status":400,"type":"AttributeExists"}}},"Create product text attribute - 400 (invalid value)":{"value":{"error":{"code":10007,"messages":["#/type: text is not a valid enum value","#/value: expected type: JSONArray, found: String","#/type: text is not a valid enum value","#/value: expected type: Integer, found: String","#/type: text is not a valid enum value","#/value: expected type: Number, found: String","#/type: text is not a valid enum value","#/value: string [] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/type: text is not a valid enum value","#/value: string [] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Category

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-category.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Category"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single category. If a category is successfully created, the response will include the category `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | yes |
| `parent` | yes |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"language":{"type":"string","example":"NL"},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"examples":{"Create Category":{"value":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Category - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"365"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 08:56:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b29dbca8-6be3-4ef2-a1e1-7fd289adad73"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1771},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"messages":{"type":"array","items":{"type":"string","example":"Category created"},"example":["Category created"]},"total":{"type":"number","example":1}}},"examples":{"Create Category - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1771,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"},"messages":["Category created"],"total":1}}}}}},"400":{"description":"Create Category - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 08:57:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b280cd08-4545-4606-9c43-5030888faa13"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: required key [names] not found"},"example":["#: required key [names] not found","#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Category - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: required key [names] not found","#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clustersconfig/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | yes |
| `settings` | no |

## Settings

| **Name** | **Required** |
| --- | --- |
| `attributeName` | yes |
| `displayType` | yes |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR111"},"displayType":{"type":"string","example":"color"},"priority":{"type":"number","example":1}}},"example":[{"attributeName":"PROPELLER_COLOR111","displayType":"color","priority":1}]}}},"examples":{"Create Cluster Config":{"value":{"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR111","displayType":"color","priority":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster Config - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"206"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:23:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"9ffed010-ae3b-48d6-87a5-a36ec3d6a323"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"color"},"id":{"type":"number","example":115},"priority":{"type":"number","example":1}}},"example":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":1}]}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config created"},"example":["Cluster Config created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Config - 201":{"value":{"data":{"id":11,"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":1}]},"messages":["Cluster Config created"],"total":1}}}}}},"400":{"description":"Create Cluster Config - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"222"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:24:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"12f3598c-627c-4791-9384-3b20c3e6a83a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21004},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."},"example":["Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"ClusterConfigExists"}}}}},"examples":{"Create Cluster Config - 400":{"value":{"error":{"code":21004,"messages":["Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."],"moreInfo":"https://www.propel.us/docs/errors/21004","status":400,"type":"ClusterConfigExists"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster Option

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-cluster-option.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster Option"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/options"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `isRequired` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"89"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"examples":{"Create Cluster Option":{"value":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster Option - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:34:01 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"76e88d05-5fb9-4fe6-90d1-6e2ec0c21f14"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"id":{"type":"number","example":214},"isRequired":{"type":"string","example":"N"},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option created"},"example":["Cluster Option created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Option - 201":{"value":{"data":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"id":214,"isRequired":"N","language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},"messages":["Cluster Option created"],"total":1}}}}}},"404":{"description":"Create Cluster Option - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:35:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"326e0985-904b-4193-b3ba-a9ecf6e29ec1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [215] not found"},"example":["Parent Cluster with id [215] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Create Cluster Option - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [215] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-cluster.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `parent` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `clusterConfigId` | yes |
| `code` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"sku":{"type":"string","example":"15120300"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"15120300"}}},"examples":{"Create Cluster":{"value":{"clusterConfigId":11,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"language":"NL","names":[{"language":"NL","value":"Balpen Slider XB extra"}],"parent":{"id":23409},"sku":"15120300","source":"REST-API","sourceId":"15120300"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"426"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:17:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c5864837-c3a7-46e9-9058-f29b8589d6f7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"15120300"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"id":{"type":"number","example":210},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"15120300"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster created"},"example":["Cluster created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster - 201":{"value":{"data":{"clusterConfigId":11,"code":"15120300","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"id":210,"language":"NL","names":[{"language":"NL","value":"Balpen Slider XB extra"}],"parent":{"id":23409},"source":"REST-API","sourceId":"15120300"},"messages":["Cluster created"],"total":1}}}}}},"400":{"description":"Create Cluster - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:18:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"75a3a020-8e41-4b1b-9e7e-e5ba0878cb13"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [sku] is not permitted"},"example":["#: extraneous key [sku] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Cluster - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [sku] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Option Product

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-option-product.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Option Product"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/products"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id 
  

Use this endpoint to create a single product to the option. If a option product is successfully created, the response will include the product`id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Create Cluster Product":{"value":{"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1}},"Create Option Product":{"value":{"costPrice":19.05,"descriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"language":"NL","manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"notes":[{"language":"NL","value":"option product"}],"oemCode":"K72334","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":22.3,"shortDescriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"shortName":"Dell draadloze lasermuis via nano USB ontvanger","sku":"K72334","source":"REST-API","sourceId":"K72334","status":"A","suggestedPrice":22.3,"supplier":"REST-API","supplierCode":"K72334","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Option Product - 201 / Create Cluster Product - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"973"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:22:32 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a7b7f777-e7ad-4932-9a3b-d48a76cdd07b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":19.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707972},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"DELL"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"option product"}}},"example":[{"language":"NL","value":"option product"}]},"oemCode":{"type":"string","example":"K72334"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":22.3},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"shortName":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"},"sku":{"type":"string","example":"K72334"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":22.3},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"K72334"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product created"},"example":["Cluster Product created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Product - 201":{"value":{"data":{"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","id":707966,"language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1},"messages":["Cluster Product created"],"total":1}},"Create Option Product - 201":{"value":{"data":{"costPrice":19.05,"descriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"id":707972,"language":"NL","manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"notes":[{"language":"NL","value":"option product"}],"oemCode":"K72334","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":22.3,"shortDescriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"shortName":"Dell draadloze lasermuis via nano USB ontvanger","sku":"K72334","source":"REST-API","sourceId":"K72334","status":"A","suggestedPrice":22.3,"supplier":"REST-API","supplierCode":"K72334","taxCode":"H","unit":1},"messages":["Cluster Product created"],"total":1}}}}}},"404":{"description":"Create Cluster Product - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:22:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"6d9bf531-516c-4bec-9305-e49b5ab1b9d4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [213] not found"},"example":["Parent Cluster with id [213] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Create Cluster Product - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [213] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Order

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-order.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Order"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an order.

## Order identification

Orders imported via the REST api need to specify an `order`identifier. This identifier is used by Propeller to determine if an order has already been imported before into Propellor or not.

```json
{
    "source" : "MsBusinessCentral",
    "sourceId :  "order-1234"
}
```

## Create an order using an existing user resource

Orders can be created referencing an existing `user` / `contact` or `customer` resource. A user resource can be referenced using a [lookupKey](/reference/legacy/rest-sonar/orders#order-lookup-keys) in the `clientData` element.

```json
{
    "clientData": {
        "user": {
            "source" : "MsBusinessCentral",
            "sourceId :  "user-1234"
        }
    }
}
```

## Create an order using the anonymous user

Creating an order can be done without referencing an existing `user`,`contact` or `customer` object. When no `clientData`element is present in the payload a `firstName`, `middleName`, `lastName` and `email` needs to be present in the root or the `order` payload.

```json
{
    "firstName" : "Miles",
    "middleName" : "",
    "lastName" : "McCoy",
    "email" : "miles@propel.us"
}
```

Anonymous orders are not linked to any existing `user` / `contact` or `customer` resource in Propeller. Anonymous orders are e.g. usefull when Propeller acts as a "in between" a marketplace (e.g. Amazon) and an ERP system. Marketplace orders are imported into Propeller and from Propeller exported to the ERP system. There is no added value of creating separate users for each Marketplace order in Propeller.

## Referencing products as order items

an `orderItem` always contains a reference to an existing `product` using a [lookupKey](/reference/legacy/rest-sonar/orders#order-lookup-keys)

```json
{
   "type": "product",
   "source" : "MsBusinessCentral",
   "sourceId :  "product-1234"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"accountingId":{"type":"string","example":""},"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"contact":{"type":"object","properties":{"source":{"type":"string","example":"MsBusinessCentral"},"sourceId":{"type":"string","example":"contact-1234"}}}}},"date":{"type":"string","example":"2023-03-03T13:10:45"},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"url":{"type":"string","example":"www.propel.us"}}}}},"items":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number","example":2},"sku":{"type":"string","example":"411544"},"type":{"type":"string","example":"product"}}},"example":[{"quantity":2,"sku":"411544","type":"product"}]},"language":{"type":"string","example":"EN"},"merchantCost":{"type":"number","example":4.9},"reference":{"type":"string","example":"reference text"},"remarks":{"type":"string","example":"remarks text"},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"url":{"type":"string","example":"www.propel.us"}}}}},"source":{"type":"string","example":"MsBusinessCentral"},"sourceId":{"type":"string","example":"order-123478"},"status":{"type":"string","example":"NEW"},"total":{"type":"object","properties":{"discountAmount":{"type":"number","example":5}}},"trackTraceCode":{"type":"string","example":""}}},"examples":{"Create Order":{"value":{"accountingId":"","channelId":1,"clientData":{"contact":{"source":"MsBusinessCentral","sourceId":"contact-1234"}},"date":"2023-03-03T13:10:45","invoiceData":{"address":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","gender":"U","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","url":"www.propel.us"}},"items":[{"quantity":2,"sku":"411544","type":"product"}],"language":"EN","merchantCost":4.9,"reference":"reference text","remarks":"remarks text","shippingData":{"address":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","gender":"U","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","url":"www.propel.us"}},"source":"MsBusinessCentral","sourceId":"order-123478","status":"NEW","total":{"discountAmount":5},"trackTraceCode":""}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Order - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2431"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 10:53:12 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"5a7bf152-60fd-4b7d-b022-6a438ff8a4a5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"accountingId":{"type":"string","example":""},"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"AU"},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":"ANONYMOUS"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Anonymous"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14644},"lastName":{"type":"string","example":"User"},"login":{"type":"string","example":""},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":"Anonymous User"},"phone":{"type":"string","example":""},"pricelistAmount":{"type":"string","example":"JONSPR"},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":""},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""}}},"date":{"type":"string","example":"2023-03-03T13:10:45"},"debtorId":{"type":"string","example":"ANONYMOUS"},"email":{"type":"string","example":"miles@propel.us"},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":"extrainfo text"},"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":557},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":105950},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"items":{"type":"array","items":{"type":"object","properties":{"childItems":{"type":"array","items":{},"example":[]},"discountAmount":{"type":"number","example":0},"discountAmountNet":{"type":"number","example":0},"discountAmountTotal":{"type":"number","example":0},"discountAmountTotalNet":{"type":"number","example":0},"discountPercentage":{"type":"number","example":0},"name":{"type":"string","example":"Drum Oki 44318508 zwart"},"notes":{"type":"string","example":""},"price":{"type":"number","example":71.74},"quantity":{"type":"number","example":2},"sku":{"type":"string","example":"411544"},"supplier":{"type":"string","example":""},"supplierCode":{"type":"string","example":""},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"type":{"type":"string","example":"product"},"unit":{"type":"number","example":1}}},"example":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Drum Oki 44318508 zwart","notes":"","price":71.74,"quantity":2,"sku":"411544","supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"type":"product","unit":1}]},"language":{"type":"string","example":""},"lastName":{"type":"string","example":"McCoy"},"merchantCost":{"type":"number","example":4.9},"middleName":{"type":"string","example":""},"orderSource":{"type":"string","example":"API"},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"string","example":""},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"pickUpLocationId":{"type":"number","example":0},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":"reference text"},"remarks":{"type":"string","example":"remarks text"},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":105951},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shop":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Propellor Sonar"}}},"shopId":{"type":"number","example":1},"status":{"type":"string","example":"NEW"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":3.48481},"discountValue":{"type":"number","example":5},"tax":{"type":"object","properties":{"0":{"type":"number","example":0},"21":{"type":"number","example":29.6058}}},"totalGross":{"type":"number","example":138.48},"totalNet":{"type":"number","example":167.5608}}},"trackTraceCode":{"type":"string","example":""},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14644}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Create Order - 200":{"value":{"data":{"accountingId":"","channelId":1,"clientData":{"abbreviation":"AU","dateOfBirth":"","debtorId":"ANONYMOUS","email":"","fax":"","firstName":"Anonymous","gender":"U","id":14644,"lastName":"User","login":"","middleName":"","mobile":"","name":"Anonymous User","phone":"","pricelistAmount":"JONSPR","pricelistPercentage":"","primaryLanguage":"","ssn":"","title":""},"date":"2023-03-03T13:10:45","debtorId":"ANONYMOUS","email":"miles@propel.us","externalId":"","extraInfo":"extrainfo text","firstName":"Miles","id":557,"invoiceData":{"address":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":105950,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"","name":"","notes":"","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"invoice","url":""}},"itemCount":1,"items":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Drum Oki 44318508 zwart","notes":"","price":71.74,"quantity":2,"sku":"411544","supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"type":"product","unit":1}],"language":"","lastName":"McCoy","merchantCost":4.9,"middleName":"","orderSource":"API","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":"","transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","pickUpLocationId":0,"postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"reference text","remarks":"remarks text","shippingData":{"address":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":105951,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"","name":"","notes":"","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":""}},"shop":{"id":1,"name":"Propellor Sonar"},"shopId":1,"status":"NEW","total":{"discountPercentage":3.48481,"discountValue":5,"tax":{"0":0,"21":29.6058},"totalGross":138.48,"totalNet":167.5608},"trackTraceCode":"","type":"dropshipment","userId":14644},"messages":[],"total":1}}}}}},"400":{"description":"Create Order - 400 (order already exists)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 10:54:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"29e614eb-af2f-416e-8d36-0992efded582"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15004},"messages":{"type":"array","items":{"type":"string","example":"Order with sourceId [order-1234] already exists"},"example":["Order with sourceId [order-1234] already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"OrderExists"}}}}},"examples":{"Create Order - 400 (order already exists)":{"value":{"error":{"code":15004,"messages":["Order with sourceId [order-1234] already exists"],"moreInfo":"https://www.propel.us/docs/errors/15004","status":400,"type":"OrderExists"}}}}}}},"404":{"description":"Create Order - 404 (product not found) / Create Order - 404 (contact not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"179"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 11:00:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"da7a3f29-97e5-4fb1-a45d-a361139d742a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"product with sku [411544167] not found"},"example":["product with sku [411544167] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Order - 404 (contact not found)":{"value":{"error":{"code":50006,"messages":["contact with sourceId [contact-1234] not found"],"moreInfo":"https://www.propel.us/docs/errors/50006","status":404,"type":"contactNotFound"}}},"Create Order - 404 (product not found)":{"value":{"error":{"code":80006,"messages":["product with sku [411544167] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Pricesheet Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-pricesheet-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Pricesheet Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/pricesheets/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-sonar/pricesheets) for an existing price sheet. The price sheet can be identified by it's lookup key. It is required to provide either `categories` or `products` or both.

## Use cases

A common use case for this endpoint is when you want to give discounts on all products in a certain category or set a specific price from your ERP system for a product. You can decide to assign a price sheet to only one or multiple users. You can also create a price sheet in advance, create the pricing and have it be ready to assign to a user or usergroup at any given moment i.e. when a sales team decides to.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The discount will apply on all products that belong in that category.

Another common use case is to set a specific price for a product. This is usually used when your ERP system is responsible for the complex price calculations or simply your sales team agreed on a specific price for a product.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-sonar/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":17795},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"CP"},"validFrom":{"type":"string","example":"2022-05-01"},"validTo":{"type":"string","example":"2022-12-31"}}}}},"example":[{"id":17795,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"2022-05-01","validTo":"2022-12-31"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":40364},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"SP"},"validFrom":{"type":"string","example":"2022-05-01"},"validTo":{"type":"string","example":"2022-12-31"}}}}},"example":[{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"2022-05-01","validTo":"2022-12-31"}},{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"2022-05-01","validTo":"2022-12-31"}}]}}},"examples":{"Create Pricesheet Pricing":{"value":{"categories":[{"id":17795,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"2022-05-01","validTo":"2022-12-31"}}],"products":[{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"2022-05-01","validTo":"2022-12-31"}},{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"2022-05-01","validTo":"2022-12-31"}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Pricesheet Pricing / Create Pricesheet Pricing - 200 (invalid category)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"285"}},"date":{"schema":{"type":"string","example":"Fri, 01 Apr 2022 07:52:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fe6530f0-afa0-4a82-bcd4-7d797245d595"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"key":{"type":"number","example":1779},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1779,"lookupKey":"id","success":true},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Pricesheet Pricing":{"value":{"data":[{"action":"create","key":1779,"lookupKey":"id","success":true},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}],"messages":["completed"],"total":3}},"Create Pricesheet Pricing - 200 (invalid category)":{"value":{"data":[{"action":"create","error":"category with id [17795] not found","key":17795,"lookupKey":"id","success":false},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}],"messages":["completed"],"total":3}}}}}},"400":{"description":"Create Pricesheet Pricing - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:19:46 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e580c6c8-feda-473b-9efd-d40d1454c708"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [product] is not permitted"},"example":["#: extraneous key [product] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Pricesheet Pricing - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [product] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Pricesheet Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"200"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:33:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"00967621-4860-45b6-8e44-1eb6d4fffc09"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12005},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Pricesheets] with code [3A212] not found"},"example":["Parent resource [Pricesheets] with code [3A212] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentPricesheetsNotFound"}}}}},"examples":{"Create Pricesheet Pricing - 404":{"value":{"error":{"code":12005,"messages":["Parent resource [Pricesheets] with code [3A212] not found"],"moreInfo":"https://www.propel.us/docs/errors/12005","status":404,"type":"ParentPricesheetsNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Pricesheet

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-pricesheet.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Pricesheet"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/pricesheets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a price sheet. If a price sheet is successfully created, the response will include the price sheet `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `code` | yes |
| `shopId` | no  <br />Defaults to first shop found |
| `name` | no |
| `description` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"number","example":21}}},"examples":{"Create Pricesheet":{"value":{"code":"3A21","description":"","name":21}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Pricesheet - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"120"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:15:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"91f4a72b-2056-40ad-a8ba-0527a80d7abc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"id":{"type":"number","example":11},"name":{"type":"string","example":"Pricesheet 3A21"}}},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet created"},"example":["Pricesheet created"]},"total":{"type":"number","example":1}}},"examples":{"Create Pricesheet - 200":{"value":{"data":{"code":"3A21","description":"","id":11,"name":"Pricesheet 3A21"},"messages":["Pricesheet created"],"total":1}}}}}},"400":{"description":"Create Pricesheet - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"188"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:16:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"983ca163-ac57-472e-b246-e57674fbd5a0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/name: expected type: String, found: Integer"},"example":["#/name: expected type: String, found: Integer"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Pricesheet - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/name: expected type: String, found: Integer"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product Local Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-product-local-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product Local Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/{lookupkey}/{key}/inventory/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows creating local inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

On creating a record, inventory type **local** is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: **sku**, **warehouseId** and **location,** error is thrown that duplicate record can't be created.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":16},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Create Product Local Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":16,"usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product Local Inventory - 201 / Create Product Local Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"330"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 15:08:39 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T11:04:29"},"id":{"type":"number","example":16194},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":16},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory created"},"example":["Inventory created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product Local Inventory - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T11:04:29","id":16194,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory created"],"total":1}},"Create Product Local Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T15:08:39","id":16148,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227235,"quantity":16,"sku":"9789006953374","supplier":"INTERN","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory created"],"total":1}}}}}},"400":{"description":"Create Product Local Inventory - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"157"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:04:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6fa715b9-3713-4c89-bdf1-069517106c53"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13004},"messages":{"type":"array","items":{"type":"string","example":"Inventory already exists"},"example":["Inventory already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InventoryExists"}}}}},"examples":{"Create Product Local Inventory - 400":{"value":{"error":{"code":13004,"messages":["Inventory already exists"],"moreInfo":"https://www.propel.us/docs/errors/13004","status":400,"type":"InventoryExists"}}}}}}},"404":{"description":"Create Product Local Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:05:01 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"298fde61-a7bd-4f67-a059-fae3ea541591"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Product Local Inventory - 404":{"value":{"error":{"code":80006,"messages":["Product with id [98952] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product Supplier Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-product-supplier-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product Supplier Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/{lookupkey}/{key}/inventory/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows creating supplier inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `supplier` (string) | no  <br />Default value is product supplier |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

On creating a record, inventory type **supplier** is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: **supplier**, **supplierCode**, **warehouseId** and **location,** error is thrown that duplicate record can't be created.

## InventoryCompanyUsergroup Resource

A `InventoryCompanyUsergroup` resource is a JSON object used for identifying a company or usergroup when creating company/ usergroup specific stock record. It can be identified by either an id or source/ sourceId.

```json
{
    "id": 56987
}
```
```json
   "sourceId": "1",
   "source": "TECHDATA",
   "language": "NL"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":16},"supplier":{"type":"string","example":"KERRIDGE"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Create Product Supplier Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":16,"supplier":"KERRIDGE","usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product Supplier Inventory - 201 / Create Product Supplier Inventory for a usergroup - 201","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"332"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 15:03:49 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T11:06:39"},"id":{"type":"number","example":16195},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":16},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"KERRIDGE"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory created"},"example":["Inventory created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product Supplier Inventory - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T11:06:39","id":16195,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory created"],"total":1}},"Create Product Supplier Inventory for a usergroup - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T15:03:49","id":16146,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227235,"quantity":16,"sku":"9789006953374","supplier":"KERRIDGE","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory created"],"total":1}}}}}},"400":{"description":"Create Product Supplier Inventory - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"157"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:06:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"727ad1af-8637-4512-8e7d-1be97c91017f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13004},"messages":{"type":"array","items":{"type":"string","example":"Inventory already exists"},"example":["Inventory already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InventoryExists"}}}}},"examples":{"Create Product Supplier Inventory - 400":{"value":{"error":{"code":13004,"messages":["Inventory already exists"],"moreInfo":"https://www.propel.us/docs/errors/13004","status":400,"type":"InventoryExists"}}}}}}},"404":{"description":"Create Product Supplier Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:07:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b22dee12-41cb-411e-813b-56370e516d45"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Product Supplier Inventory - 404":{"value":{"error":{"code":80006,"messages":["Product with id [98952] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-product.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single product. If a product is successfully created, the response will include the product`id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `language` | yes |
| `parent` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `costPrice` | no  <br />Default is `0.00` |
| `suggestedPrice` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortName` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `manufacturer` | no |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `package` | no |
| `packageDescriptions` | no |
| `notes` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Create Product":{"value":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2854"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d6169a2d-ed01-4abd-b306-4da9e44d56bb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1771}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Product created"},"example":["Product created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"language":"NL","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1771},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},"messages":["Product created"],"total":1}}}}}},"400":{"description":"Create Product - 400 (existing sourceId)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"180"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:15:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e7ee4951-7e62-4923-bc92-04030f60ec74"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80004},"messages":{"type":"array","items":{"type":"string","example":"Product with sourceId [NCABD70004] already exists"},"example":["Product with sourceId [NCABD70004] already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"ProductExists"}}}}},"examples":{"Create Product - 400 (existing sourceId)":{"value":{"error":{"code":80004,"messages":["Product with sourceId [NCABD70004] already exists"],"moreInfo":"https://www.propel.us/docs/errors/80004","status":400,"type":"ProductExists"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Shipment

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-shipment.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Shipment"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/{lookupKey}/{lookupValue}/shipments"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a `shipment` which marks `orderItems` as delivered and adds track and trace information to the `order`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `deliveryId` | yes |
| `deliveryDate` | no |
| `supplier` | yes |
| `colli` | no |
| `notes` | no |
| `shipDate` | no |
| `items` | yes |
| `items`.sku | yes |
| `items`.name | yes |
| `items`.supplierCode | no |
| `items`.quantity | yes |
| `items`.cancelled | no  <br />  <br />Default is `0` |
| `items`.notes | no |
| `items`.externalLineId | no |
| `tracktrace` | no |
| `tracktrace`.carrierName | yes |
| `carrierName`.code | yes |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"colli":{"type":"number","example":1},"deliveryDate":{"type":"string","example":"2022-05-21T00:00:00"},"deliveryId":{"type":"string","example":"D185FA63-38F0-4612-B4413FA5B71E3CE6"},"items":{"type":"array","items":{"type":"object","properties":{"externalLineId":{"type":"string","example":""},"name":{"type":"string","example":"Gallagher MBS400 fence energiser (230V/12V/Solar)"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":1},"sku":{"type":"string","example":"390307"},"supplierCode":{"type":"string","example":"390307"}}},"example":[{"externalLineId":"","name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","quantity":1,"sku":"390307","supplierCode":"390307"}]},"notes":{"type":"string","example":""},"supplier":{"type":"string","example":"INTERN"},"tracktrace":{"type":"array","items":{"type":"object","properties":{"carrierName":{"type":"string","example":"DHL"},"code":{"type":"string","example":"12345"}}},"example":[{"carrierName":"DHL","code":"12345"}]}}},"examples":{"Create Shipment":{"value":{"colli":1,"deliveryDate":"2022-05-21T00:00:00","deliveryId":"D185FA63-38F0-4612-B4413FA5B71E3CE6","items":[{"externalLineId":"","name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","quantity":1,"sku":"390307","supplierCode":"390307"}],"notes":"","supplier":"INTERN","tracktrace":[{"carrierName":"DHL","code":"12345"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Shipment - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"55"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 18:04:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"69b34018-6b10-4362-bdde-21a2125b7925"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Shipment created"},"example":["Shipment created"]},"total":{"type":"number","example":1}}},"examples":{"Create Shipment - 200":{"value":{"data":{},"messages":["Shipment created"],"total":1}}}}}},"400":{"description":"Create Shipment - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"234"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 17:46:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b11b44a6-a84b-4868-b66a-668d718e2dac"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/items/0: required key [sku] not found"},"example":["#/items/0: required key [sku] not found","#/items/0: extraneous key [code] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Shipment - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/items/0: required key [sku] not found","#/items/0: extraneous key [code] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Shipment - 404 (order not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 18:10:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c0e35a45-6752-466c-bab2-f7034f9d516f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [300] not found"},"example":["Order with id [300] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Create Shipment - 404 (order not found)":{"value":{"error":{"code":15001,"messages":["Order with id [300] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a user. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create User Address":{"value":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create User Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create User Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create User Address - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create User Address - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create User Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Create User Address - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-user-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-sonar/pricesheets) for an existing user. The user can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific user.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The user will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single user.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14718"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":50887},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":50887,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1036521},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":1036521,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create User Pricing":{"value":{"categories":[{"id":50887,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":1036521,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create User Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:18:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7f30de39-8de3-4357-9069-82d776161996"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"error":{"type":"string","example":"product with id [1036522] not found"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create User Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}],"messages":["completed"],"total":3}}}}}},"404":{"description":"Create User Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"186"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 13:53:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"71944e53-63f3-4944-83cd-e2852346da21"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [14699] not found"},"example":["Parent resource [User] with id [14699] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Create User Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [14699] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-user.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single user. If a user is successfully created, the response will include the user `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Create User":{"value":"{\r\n    \"language\": \"NL\",\r\n    \"parent\": {\r\n        \"id\": 119\r\n    },\r\n    \"firstName\": Miles,\r\n    \"middleName\": \"\",\r\n    \"lastName\": \"McCoy\",\r\n    \"abbreviation\": \"MM\",\r\n    \"debtorId\": 12345,\r\n    \"email\": \"miles@propel.us\",\r\n    \"mobile\": \"0038975648\",\r\n    \"phone\": \"0032445888\",\r\n    \"dateOfBirth\": \"28/08/1993\",\r\n    \"title\": \"Mr.\",\r\n    \"gender\": \"M\",\r\n    \"login\": \"miles@propel.us\",\r\n    \"source\": \"REST-API\",\r\n    \"sourceId\": 3002196\r\n}"}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create User - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"352"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:41:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0e0d6f5b-db70-49df-89b0-ae2c724556dc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14759},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"User created"},"example":["User created"]},"total":{"type":"number","example":1}}},"examples":{"Create User - 201":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":14759,"language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["User created"],"total":1}}}}}},"400":{"description":"Create User - 400 (invalid payload)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:44:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d91d8445-2728-4a75-91b0-1b52c6066a9b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10005},"messages":{"type":"array","items":{"type":"string","example":"Invalid JSON Payload"},"example":["Invalid JSON Payload"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidJSONPayload"}}}}},"examples":{"Create User - 400 (invalid payload)":{"value":{"error":{"code":10005,"messages":["Invalid JSON Payload"],"moreInfo":"https://www.propel.us/docs/errors/10005","status":400,"type":"InvalidJSONPayload"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-usergroup-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a usergroup. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create Usergroup Address":{"value":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Usergroup Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create Usergroup Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81918,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create Usergroup Address - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Usergroup Address - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Usergroup Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Create Usergroup Address - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-usergroup-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-sonar/pricesheets) for an existing usergroup. The usergroup can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific usergroup and all users in that usergroup. If a user in that usergroup already has pricing defined, the price set on the parent usergroup will be ignored.

If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The usergroup will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for users in a given usergroup.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1797},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":77138},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create Usergroup Pricing":{"value":{"categories":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Usergroup Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:40:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"463a1983-f185-4027-9906-e95c8884711e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"error":{"type":"string","example":"product with id [1036522] not found"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Usergroup Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}],"messages":["completed"],"total":3}}}}}},"404":{"description":"Create Usergroup Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"197"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:31:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a009a732-a593-4242-aed6-0ad86535ca35"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [122589] not found"},"example":["Parent resource [Usergroup] with id [122589] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Create Usergroup Pricing - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [122589] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/create-usergroup.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single usergroup. If a usergroup is successfully created, the response will include the usergroup `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | no |
| `language` | no |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"examples":{"Create Usergroup":{"value":"{\r\n    \"language\": \"NL\",\r\n    \"parent\": {\r\n        \"id\": 119\r\n    },\r\n    \"name\": Netherlands,\r\n    \"company\": \"\",\r\n    \"department\": \"\",\r\n    \"office\": \"\",\r\n    \"notes\": \"Usergroup created from API\",\r\n    \"inheritProductList\": \"Y\",\r\n    \"inheritOrderList\": \"N\",\r\n    \"budget\": \"N\",\r\n    \"budgetInherit\": \"N\"\r\n}"}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Usergroup - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"278"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:14:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"05af9b7b-c9d1-408d-bd8e-be10812818a7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup created"},"example":["Usergroup created"]},"total":{"type":"number","example":1}}},"examples":{"Create Usergroup - 201":{"value":{"data":{"budget":"N","budgetInherit":"N","company":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}},"messages":["Usergroup created"],"total":1}}}}}},"400":{"description":"Create Usergroup - 400 (invalid payload)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:44:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d91d8445-2728-4a75-91b0-1b52c6066a9b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10005},"messages":{"type":"array","items":{"type":"string","example":"Invalid JSON Payload"},"example":["Invalid JSON Payload"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidJSONPayload"}}}}},"examples":{"Create Usergroup - 400 (invalid payload)":{"value":{"error":{"code":10005,"messages":["Invalid JSON Payload"],"moreInfo":"https://www.propel.us/docs/errors/10005","status":400,"type":"InvalidJSONPayload"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to delete an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.  
  
When an attribute is deleted all the values set on resources (products, users, etc.) will be deleted as well.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete attribute by Id - 200 / Delete attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:53:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"940ff23c-8c5d-4d9a-b533-408e456a960f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Attribute deleted"},"example":["Attribute deleted"]}}},"examples":{"Delete attribute by Id - 200":{"value":{"data":{},"messages":["Attribute deleted"]}},"Delete attribute by name and class - 200":{"value":{"data":{},"messages":["Attribute deleted"]}}}}}},"404":{"description":"Delete attribute by Id - 404 / Delete attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"202"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:53:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"da6ad28e-989d-4ac2-a52c-a499b9944219"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [85] not found."},"example":["Attribute with id [85] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Delete attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [85] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Delete attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [COLOR] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"45"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:50:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"17694f03-bade-42cd-b6eb-6d3a8a26e059"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Category deleted"},"example":["Category deleted"]}}},"examples":{"Delete Category by Id - 200":{"value":{"data":{},"messages":["Category deleted"]}}}}}},"404":{"description":"Delete Category by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:51:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ba822dc2-7469-4fe8-947c-df32cc262366"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [2947] not found"},"example":["Category with sourceId [2947] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Delete Category by Id - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [2947] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Category translation by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-category-translation-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Category translation by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/categories/{lookupKey}/{lookupValue}/translation/{translationLanguage}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete category translation by lookup key and the language for which the translation needs to be deleted. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1773"},"description":"The value of the key (id or sourceId)"},{"name":"translationLanguage","in":"path","required":true,"schema":{"type":"string","example":"FR"},"description":"The language to delete. Cannot be the default language of the category"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Category translation by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"48"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:26:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"339c22fa-5963-4449-ba88-b36251b74bd7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Translation deleted"},"example":["Translation deleted"]}}},"examples":{"Delete Category translation by Id - 200":{"value":{"data":{},"messages":["Translation deleted"]}}}}}},"404":{"description":"Delete Category translation by Id - 404 (Category not found) / Delete Category translation by Id - 404 (Translation not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:27:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0b6c651a-8a34-4e95-894e-b9acf9da929c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with id [2947] not found"},"example":["Category with id [2947] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Delete Category translation by Id - 404 (Category not found)":{"value":{"error":{"code":30006,"messages":["Category with id [2947] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}},"Delete Category translation by Id - 404 (Translation not found)":{"value":{"error":{"code":10018,"messages":["[FR] translation for category with id [1773] not found"],"moreInfo":"https://www.propel.us/docs/errors/10018","status":404,"type":"TranslationNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete cluster by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Cluster by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:43:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"716bdaeb-9ef7-402d-9fb3-ef76ee5fe20b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster deleted"},"example":["Cluster deleted"]}}},"examples":{"Delete Cluster by lookup key - 200":{"value":{"data":{},"messages":["Cluster deleted"]}}}}}},"404":{"description":"Delete Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"164"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:43:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"421ba89a-a9cf-4449-92e1-34ba209a81c3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [213] not found"},"example":["Cluster with id [213] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Delete Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [213] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows deleting inventory record by it's Propeller inventory id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Inventory by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:04:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5ac2d4fc-9402-40fa-96cd-5593689b756a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Inventory deleted"},"example":["Inventory deleted"]}}},"examples":{"Delete Inventory by Id - 200":{"value":{"data":{},"messages":["Inventory deleted"]}}}}}},"404":{"description":"Delete Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:04:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6404936a-7275-4eaf-8b60-f12e3846d4b2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Delete Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a link by Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Link by Id 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"41"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 15:05:04 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Link deleted"},"example":["Link deleted"]}}},"examples":{"Delete Link by Id 200":{"value":{"data":{},"messages":["Link deleted"]}}}}}},"404":{"description":"Delete Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 15:05:18 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [485377] not found"},"example":["Link with id [485377] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Delete Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [485377] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"51"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:43:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f227705b-07ef-4c26-95f6-501459df0c3b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option deleted"},"example":["Cluster Option deleted"]}}},"examples":{"Delete Option by Cluster lookup key and Option Id - 200":{"value":{"data":{},"messages":["Cluster Option deleted"]}}}}}},"404":{"description":"Delete Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:43:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"03a4766d-9840-4e35-9f96-8ec2b675968b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [216] not found for the cluster with id [213]"},"example":["Cluster Option with id [216] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Delete Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [216] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Pricesheet by lookup id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-pricesheet-by-lookup-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Pricesheet by lookup id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/pricesheets/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint deletes a price sheet and it's pricing. The price sheet can be identified by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-sonar/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Pricesheet by code - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:37:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e1f828f0-067d-4b98-bdbd-a79426881dc7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Pricesheet by code - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Pricesheet by code - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:40:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"adce4eff-80c0-4036-8f0b-35d573673bc1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12002},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet with code [3A221] not found"},"example":["Pricesheet with code [3A221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12002"},"status":{"type":"number","example":404},"type":{"type":"string","example":"PricesheetNotFound"}}}}},"examples":{"Delete Pricesheet by code - 404":{"value":{"error":{"code":12002,"messages":["Pricesheet with code [3A221] not found"],"moreInfo":"https://www.propel.us/docs/errors/12002","status":404,"type":"PricesheetNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Pricesheet Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-pricesheet-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Pricesheet Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/pricesheets/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for a given price sheet without actually deleting the price sheet. The price sheet is identified by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-sonar/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Pricesheet Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:36:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4ccc3d95-2c3b-4919-ab74-53e6dbb46e00"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Pricesheet Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Pricesheet Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"200"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:37:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"cd235303-6610-4148-91a5-6773faf52479"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12005},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Pricesheets] with code [3A221] not found"},"example":["Parent resource [Pricesheets] with code [3A221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentPricesheetsNotFound"}}}}},"examples":{"Delete Pricesheet Pricing - 404":{"value":{"error":{"code":12005,"messages":["Parent resource [Pricesheets] with code [3A221] not found"],"moreInfo":"https://www.propel.us/docs/errors/12005","status":404,"type":"ParentPricesheetsNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"52"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:34:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"659e03d9-cc94-4a95-8bdd-acc5d9ca502b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product deleted"},"example":["Cluster Product deleted"]}}},"examples":{"Delete Product by Cluster lookup key and Product Id - 200":{"value":{"data":{},"messages":["Cluster Product deleted"]}}}}}},"404":{"description":"Delete Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:34:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"7f95d95f-dd02-40b3-9fc1-9df503518608"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707969] not found for the cluster with id [210]"},"example":["Cluster Product with id [707969] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Delete Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707969] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:24:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"27b7563c-4551-40a5-ba90-bf94e493dd33"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Product deleted"},"example":["Product deleted"]}}},"examples":{"Delete Product by Id - 200":{"value":{"data":{},"messages":["Product deleted"]}}}}}},"404":{"description":"Delete Product by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:22:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b9e159d2-8408-43a6-8447-640330bf2c84"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [48118] not found"},"example":["Product with id [48118] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Delete Product by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [48118] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product translation by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-product-translation-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product translation by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/products/{lookupKey}/{lookupValue}/translation/{translationLanguage}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete product translation by lookup key and the language for which the translation needs to be deleted. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"48118"},"description":"The value of the key (id, sourceId, sku or supplierCode)"},{"name":"translationLanguage","in":"path","required":true,"schema":{"type":"string","example":"FR"},"description":"The language to delete. Cannot be the default language of the category"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product translation by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"48"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:14:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"99ac5897-caa2-4aef-bec2-b1e62303a95e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Translation deleted"},"example":["Translation deleted"]}}},"examples":{"Delete Product translation by Id - 200":{"value":{"data":{},"messages":["Translation deleted"]}}}}}},"404":{"description":"Delete Product translation by Id - 404 (Product not found) / Delete Product translation by Id - 404 (Translation not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:13:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bb654f7b-5ab0-42ae-91aa-04a4aacd98fc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [48118] not found"},"example":["Product with id [48118] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Delete Product translation by Id - 404 (Product not found)":{"value":{"error":{"code":80006,"messages":["Product with id [48118] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}},"Delete Product translation by Id - 404 (Translation not found)":{"value":{"error":{"code":10018,"messages":["[FR] translation for product with id [40360] not found"],"moreInfo":"https://www.propel.us/docs/errors/10018","status":404,"type":"TranslationNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User Address"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a user's address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Delete User Address":{"value":{"firstName":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User Address by Id - 200 / Delete User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 19:23:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"130478fb-d22e-45a6-90ed-1980abc20734"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Address deleted"},"example":["Address deleted"]}}},"examples":{"Delete User Address by Id - 200":{"value":{"data":{},"messages":["Address deleted"]}}}}}},"404":{"description":"Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found) / Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"195"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 19:22:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"50bca6e1-d150-4256-97a3-aa52d77a14a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Delete User Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819189] not found for [Usergroup] with id [122]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Delete User Address by Id - 404 (user not found)":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a `user` by a specific lookupKey / lookupId combination. A deleted `user` will be moved to the Propeller Recycle bin. This means the deleted user can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User by Id  - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"41"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:24:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"65898282-b59a-4574-8c18-33be933da50c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"User deleted"},"example":["User deleted"]}}},"examples":{"Delete User by Id  - 200":{"value":{"data":{},"messages":["User deleted"]}}}}}},"400":{"description":"Delete User by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:25:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7e028deb-28d7-4109-a1fa-142c08fde08c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete User by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"167"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:25:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e89819f6-3aec-4e94-87b9-1e7828ad5f05"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with sourceId [146991] not found"},"example":["User with sourceId [146991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Delete User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with sourceId [146991] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-user-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing user. The user can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14718"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:29:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0081d0da-5b74-4ff7-9099-b350fceb20bd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete User Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete User Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"186"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:26:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0259b0cd-14f1-4e4c-862e-96f54d5210a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [14699] not found"},"example":["Parent resource [User] with id [14699] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Delete User Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [14699] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a usergroup by a specific lookupKey / lookupId combination. A deleted usergroup will be moved to the Propeller Recycle bin. This means the deleted usergroup can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Usergroup by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:30:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8319c262-f4a5-478c-9f75-ea4fe0ac8f0b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup deleted"},"example":["Usergroup deleted"]}}},"examples":{"Delete Usergroup by Id - 200":{"value":{"data":{},"messages":["Usergroup deleted"]}}}}}},"400":{"description":"Delete Usergroup by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:34:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e918f7a3-5711-4366-a224-0f8f71e10c2f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete Usergroup by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete Usergroup by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:31:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2fbd9182-9077-41c6-8cae-9dca0fab89ad"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21317] not found"},"example":["Usergroup with id [21317] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Delete Usergroup by Id - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21317] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Usergroup Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/delete-usergroup-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Usergroup Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/usergroups/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing usergroup. The usergroup can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Usergroup Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:42:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b695bd56-0a13-49d7-9213-ef5c80735da2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Usergroup Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Usergroup Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"197"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:41:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2fb9ab1b-d503-41ee-8aeb-4a00acd52df8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [122589] not found"},"example":["Parent resource [Usergroup] with id [122589] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Delete Usergroup Pricing - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [122589] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Access Token

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-access-token.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Access Token"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve an access token for accessing the REST APIs.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"grant_type":{"type":"string","default":"client_credentials","example":"client_credentials"}}},"examples":{"Get Access Token":{"value":{"grant_type":"client_credentials"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Access Token - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"589"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:55:16 GMT"}},"x-request-id":{"schema":{"type":"string","example":"bf951b46-1e6d-4f2a-b5e6-b87281df731b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","example":"ARAo4GjuI1bGSyenSKx5oYfFGuFQ"},"api_product_list":{"type":"string","example":"[Propeller REST APIs]"},"api_product_list_json":{"type":"array","items":{"type":"string","example":"Propeller REST APIs"},"example":["Propeller REST APIs"]},"application_name":{"type":"string","example":"a1ca275a-2abb-4bd3-82b0-3ae699d75e40"},"client_id":{"type":"string","example":"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT"},"developer.email":{"type":"string","example":"developer@propel.us"},"expires_in":{"type":"string","example":"1899"},"issued_at":{"type":"string","example":"1646873717224"},"organization_name":{"type":"string","example":"propeller-platform-prod"},"refresh_count":{"type":"string","example":"0"},"refresh_token_expires_in":{"type":"string","example":"0"},"scope":{"type":"string","example":""},"status":{"type":"string","example":"approved"},"token_type":{"type":"string","example":"BearerToken"}}},"examples":{"Get Access Token - 200":{"value":{"access_token":"ARAo4GjuI1bGSyenSKx5oYfFGuFQ","api_product_list":"[Propeller REST APIs]","api_product_list_json":["Propeller REST APIs"],"application_name":"a1ca275a-2abb-4bd3-82b0-3ae699d75e40","client_id":"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT","developer.email":"developer@propel.us","expires_in":"1899","issued_at":"1646873717224","organization_name":"propeller-platform-prod","refresh_count":"0","refresh_token_expires_in":"0","scope":"","status":"approved","token_type":"BearerToken"}}}}}},"400":{"description":"Get Access Token - 400 (invalid body value)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"90"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:59:09 GMT"}},"x-request-id":{"schema":{"type":"string","example":"4c0191c8-50f7-43c5-952d-a340bcef7208"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"Error":{"type":"string","example":"Unsupported grant type : client_credentials1"},"ErrorCode":{"type":"string","example":"invalid_request"}}},"examples":{"Get Access Token - 400 (invalid body value)":{"value":{"Error":"Unsupported grant type : client_credentials1","ErrorCode":"invalid_request"}}}}}},"401":{"description":"Get Access Token - 401 (wrong client id / client secret)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"64"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:58:18 GMT"}},"x-request-id":{"schema":{"type":"string","example":"c75881bb-a9b1-4258-922d-a8053fa1c661"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"Error":{"type":"string","example":"ClientId is Invalid"},"ErrorCode":{"type":"string","example":"invalid_client"}}},"examples":{"Get Access Token - 401 (wrong client id / client secret)":{"value":{"Error":"ClientId is Invalid","ErrorCode":"invalid_client"}}}}}}}}
>
  
</StatusCodes>

---

## Get Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-addresses-by-type-1.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all order addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"possible values:\n\ndelivery\ninvoice"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order "}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Delivery Addresses - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"795"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:18:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"02c6664d-aa51-4758-bc86-082f9e5d9360"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"w.spies@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}},"example":[{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Delivery Addresses - 200":{"value":{"data":[{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}],"messages":[],"total":2}}}}}},"404":{"description":"Get Delivery Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:12:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bab637cc-d756-4eb9-9a3e-f27c648230e0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Get Delivery Addresses - 404":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to retrieve details of an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get attribute by Id - 200 / Get attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"403"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:58:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"026fec00-dafe-43bb-843d-d84cfd590683"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"defaultLanguage":{"type":"string","example":"EN"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Color"}}},"example":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":""}}},"example":[{"language":"EN","value":""},{"language":"NL","value":""}]},"value":{"example":"","anyOf":[{"type":"string","example":""},{"type":"array","items":{},"example":[]}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get attribute by Id - 200":{"value":{"data":{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""},"messages":[],"total":1}},"Get attribute by name and class - 200":{"value":{"data":{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":85,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""}],"value":[]},"messages":[],"total":1}}}}}},"404":{"description":"Get attribute by Id - 404 / Get attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"213"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:59:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7a690144-65d6-40f8-8d8b-0ce4589da991"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [800] not found."},"example":["Attribute with id [800] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Get attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [800] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Get attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [MATERIAAL_FRAME] and attributeClass [category] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-attributes.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get attributes"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint can be used to list all existing attributes. Results will be [paginated](/reference/legacy/rest-sonar/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number. integer, optional (default: 1)"},{"name":"offset","in":"query","schema":{"type":"string","example":"20"},"description":"Number of results per page. integer, optional (default: 20)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get attributes - 200 (with results) / Get attributes - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"98"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:33:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"94282b6d-d35a-4285-bb10-897622ead1cb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"project"},"defaultLanguage":{"type":"string","example":"NL"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"PROPELLOR_PLUSPUNT_1"}}},"example":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":1},"isHidden":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isPublic":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isSearchable":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isSystem":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"name":{"type":"string","example":"AUTOMATIC_BILLING"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"AUTOMATIC_BILLING"},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"value":{"type":"array","items":{},"example":[]}}},"example":[{"class":"project","defaultLanguage":"NL","group":"","id":1,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":2,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":3,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":4,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"project","defaultLanguage":"NL","group":"","id":5,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":6,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":7,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":8,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}],"group":"","id":11,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_2"}],"group":"","id":12,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_3"}],"group":"","id":13,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_4"}],"group":"","id":15,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_5"}],"group":"","id":16,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_5","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_6"}],"group":"","id":17,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_6","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_7"}],"group":"","id":18,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_7","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_8"}],"group":"","id":19,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_8","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_1"},{"language":"EN","value":"PROPELLOR_MINPUNT_1"},{"language":"FR","value":"PROPELLOR_MINPUNT_1"}],"group":"","id":20,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""},{"language":"FR","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_2"}],"group":"","id":21,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_3"}],"group":"","id":22,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_4"}],"group":"","id":23,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]}]},"end":{"type":"number","example":20},"itemsFound":{"type":"number","example":208},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":20},"page":{"type":"number","example":1},"pages":{"type":"number","example":11},"start":{"type":"number","example":1},"total":{"type":"number","example":20}}},"examples":{"Get attributes - 200 (no results)":{"value":{"data":[],"itemsFound":208,"messages":["Completed"],"offset":20,"page":15,"pages":11,"total":1}},"Get attributes - 200 (with results)":{"value":{"data":[{"class":"project","defaultLanguage":"NL","group":"","id":1,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":2,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":3,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":4,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"project","defaultLanguage":"NL","group":"","id":5,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":6,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":7,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":8,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}],"group":"","id":11,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_2"}],"group":"","id":12,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_3"}],"group":"","id":13,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_4"}],"group":"","id":15,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_5"}],"group":"","id":16,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_5","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_6"}],"group":"","id":17,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_6","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_7"}],"group":"","id":18,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_7","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_8"}],"group":"","id":19,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_8","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_1"},{"language":"EN","value":"PROPELLOR_MINPUNT_1"},{"language":"FR","value":"PROPELLOR_MINPUNT_1"}],"group":"","id":20,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""},{"language":"FR","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_2"}],"group":"","id":21,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_3"}],"group":"","id":22,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_4"}],"group":"","id":23,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]}],"end":20,"itemsFound":208,"messages":["Completed"],"offset":20,"page":1,"pages":11,"start":1,"total":20}}}}}},"400":{"description":"Get attributes - 400 (invalid offset)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:34:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e7215195-6372-4222-ad37-40974a53b10b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10015},"messages":{"type":"array","items":{"type":"string","example":"Offset cannot be more than 100"},"example":["Offset cannot be more than 100"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10015"},"status":{"type":"number","example":400},"type":{"type":"string","example":"PaginatedResponseException"}}}}},"examples":{"Get attributes - 400 (invalid offset)":{"value":{"error":{"code":10015,"messages":["Offset cannot be more than 100"],"moreInfo":"https://www.propel.us/docs/errors/10015","status":400,"type":"PaginatedResponseException"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"expands","in":"query","schema":{"type":"string","example":"translation"},"description":"Use `translation` when retrieving translated fields in all languages. By default, only the default language of the category will be provided. [What is resource expanding?](#expanding-resources)"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"296"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:35:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b2659cec-8785-495f-a30e-7e94d7558c65"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1787},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Category by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1787,"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Category by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:12:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c768dcde-4761-49b4-b233-2c69213793a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [1771] not found"},"example":["Category with sourceId [1771] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Get Category by sourceId - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [1771] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster details by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,parent,defaultProduct,options,products,clusterConfig"},"description":"Optional.  Use `options` to retrieve the cluster options. Use `products` to retrive cluster products etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Cluster by lookup key - 200 / Get Cluster by lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2436"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:59:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"fe172ee4-a8c9-446e-9e22-bd9a36a53e3b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfig":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"OPTIONS_CLUSTER"},"settings":{"type":"array","items":{},"example":[]}}},"code":{"type":"string","example":"15120300"},"defaultobject_id":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"id":{"type":"number","example":210},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"options":{"type":"array","items":{"type":"object","properties":{"defaultProduct":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"id":{"type":"number","example":214},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]}}},"example":[{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]},{"defaultProduct":"","descriptions":[{"language":"NL","value":"Toetsenbord"}],"id":216,"isRequired":false,"names":[{"language":"NL","value":"Toetsenbord"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"KM636000"}]}]},"parent":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"id":{"type":"number","example":23409},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Clusters"}}},"example":[{"language":"NL","value":"Clusters"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"CLUSTERS"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"CLUSTERS"}]}}},"products":{"type":"array","items":{"type":"object","properties":{"costPrice":{"type":"number","example":400},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}}},"example":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707971},"manufacturer":{"type":"string","example":"DELL"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"DELL Precision 5530 Laptop - Z"}}},"example":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"base cluster product"}}},"example":[{"language":"NL","value":"base cluster product"}]},"oemCode":{"type":"string","example":"FYR88"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":555},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"DELL Precision 5530 Laptop - Z"}}},"example":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}]},"shortName":{"type":"string","example":"DELL Precision 5530 Laptop"},"sku":{"type":"string","example":"FYR88"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"FYR88"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}]},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":555},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"FYR88"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}},"example":[{"costPrice":400,"descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"eanCode":"4004675044075","id":707971,"manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"notes":[{"language":"NL","value":"base cluster product"}],"oemCode":"FYR88","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":555,"shortDescriptions":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"shortName":"DELL Precision 5530 Laptop","sku":"FYR88","sources":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}],"status":"A","suggestedPrice":555,"supplier":"REST-API","supplierCode":"FYR88","taxCode":"H","taxPercentage":0.21,"unit":1}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"CO.FYR88"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"CO.FYR88"},{"language":"NL","source":"REST-API","sourceId":"COFYR88"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Cluster by lookup key - 200":{"value":{"data":{"clusterConfig":{"id":11},"code":"15120300","defaultobject_id":"","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"id":210,"names":[{"language":"NL","value":"Balpen Slider XB extra"}],"shortDescriptions":[{"language":"NL","value":""}]},"messages":[],"total":1}},"Get Cluster by lookup key - 200 (expands)":{"value":{"data":{"clusterConfig":{"id":12,"name":"OPTIONS_CLUSTER","settings":[]},"code":"CO.FYR88","defaultobject_id":"","descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"id":213,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"options":[{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]},{"defaultProduct":"","descriptions":[{"language":"NL","value":"Toetsenbord"}],"id":216,"isRequired":false,"names":[{"language":"NL","value":"Toetsenbord"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"KM636000"}]}],"parent":{"descriptions":[{"language":"NL","value":""}],"id":23409,"names":[{"language":"NL","value":"Clusters"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[{"language":"NL","source":"REST-API","sourceId":"CLUSTERS"}]},"products":[{"costPrice":400,"descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"eanCode":"4004675044075","id":707971,"manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"notes":[{"language":"NL","value":"base cluster product"}],"oemCode":"FYR88","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":555,"shortDescriptions":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"shortName":"DELL Precision 5530 Laptop","sku":"FYR88","sources":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}],"status":"A","suggestedPrice":555,"supplier":"REST-API","supplierCode":"FYR88","taxCode":"H","taxPercentage":0.21,"unit":1}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[{"language":"NL","source":"REST-API","sourceId":"CO.FYR88"},{"language":"NL","source":"REST-API","sourceId":"COFYR88"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"164"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:21:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bac16e57-eac8-47eb-a2cf-3ce012b14f1f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [211] not found"},"example":["Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Get Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Cluster Config by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-cluster-config-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Cluster Config by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster config details by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"settings"},"description":"Optional.  Use `settings` to retrieve the settings details of the cluster config."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"8"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Cluster Config by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"184"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:51:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b8925b84-12db-4723-9022-c28943b7f16b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"color"},"id":{"type":"number","example":115},"priority":{"type":"string","example":"1"}}},"example":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":"1"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Cluster Config by lookup key - 200":{"value":{"data":{"id":11,"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":"1"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Cluster Config by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:51:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"0db5a3b1-69a8-489f-b828-1dc50c96cfd5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21005},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with id [12] not found"},"example":["Cluster Config with id [12] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigNotFound"}}}}},"examples":{"Get Cluster Config by lookup key - 404":{"value":{"error":{"code":21005,"messages":["Cluster Config with id [12] not found"],"moreInfo":"https://www.propel.us/docs/errors/21005","status":404,"type":"ClusterConfigNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to get an inventory data via it's unique inventory record Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Inventory by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"273"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 09:29:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e6c6fd2d-baeb-4cf1-ae6e-cefe5b825513"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":0},"dateModified":{"type":"string","example":"2022-02-21T12:52:38"},"id":{"type":"number","example":16141},"location":{"type":"string","example":""},"nextDeliveryDate":{"type":"string","example":"2021-02-25T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":37232},"quantity":{"type":"number","example":15},"sku":{"type":"string","example":"757540"},"supplier":{"type":"string","example":"QUANTORE"},"supplierCode":{"type":"string","example":"757540"},"usergroupId":{"type":"number","example":143},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Inventory by Id - 200":{"value":{"data":{"companyId":0,"costPrice":0,"dateModified":"2022-02-21T12:52:38","id":16141,"location":"","nextDeliveryDate":"2021-02-25T00:00:00","notes":"","productId":37232,"quantity":15,"sku":"757540","supplier":"QUANTORE","supplierCode":"757540","usergroupId":143,"warehouseId":4},"messages":[],"total":1}}}}}},"404":{"description":"Get Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 09:31:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"07314bc9-feee-4d00-98e6-5833bc3808e9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Get Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve link details by link id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Link by Id - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"250"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:53:08 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dateChanged":{"type":"string","example":"2018-11-08T11:35:38"},"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":24603}}},"id":{"type":"number","example":485377},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":false},"priority":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":27401}}},"type":{"type":"string","example":"accessories"}}},"example":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Link by Id - 200":{"value":{"data":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"}],"messages":[],"total":1}}}}}},"404":{"description":"Get Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:53:33 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [731085] not found"},"example":["Link with id [731085] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Get Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [731085] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to get details of single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,defaultProduct"}},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"examples":{"Get Option by Cluster lookup key and Option Id":{"value":""}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"301"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:38:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b5442c50-e266-4d74-8d8e-cb6740b865f9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"defaultProduct":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"id":{"type":"number","example":214},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"K72334"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Option by Cluster lookup key and Option Id - 200":{"value":{"data":{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:38:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"10b7cdcc-c009-43fe-9c84-c18123fd5f68"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [215] not found for the cluster with id [213]"},"example":["Cluster Option with id [215] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Get Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [215] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Options by Cluster lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-options-by-cluster-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Options by Cluster lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/options"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster options by cluster lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,defaultProduct"},"description":"Optional.  Use `translation` to retrieve the cluster options translations. Use `defaultProduct` to retrive cluster options default products etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"89"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Options by Cluster lookup key / Get Options by Cluster lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"1516"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:24:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"ff42f492-4f67-46b0-a82c-2a3db1d62f15"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"defaultProduct":{"type":"object","properties":{"id":{"type":"number","example":450102}}},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"id":{"type":"number","example":90},"isRequired":{"type":"boolean","example":true},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"First option"}}},"example":[{"language":"NL","value":"First option"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]}}},"example":[{"defaultProduct":{"id":450102},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}]},{"defaultProduct":{"id":661190},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}]}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Options by Cluster lookup key":{"value":{"data":[{"defaultProduct":{"id":450102},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}]},{"defaultProduct":{"id":661190},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}]}],"messages":[],"total":2}},"Get Options by Cluster lookup key - 200 (expands)":{"value":{"data":[{"defaultProduct":{"costPrice":0,"descriptions":[{"language":"NL","value":""}],"eanCode":"","id":450102,"manufacturer":"","minimumQuantity":1,"names":[{"language":"NL","value":"My first option"}],"notes":[{"language":"NL","value":""}],"oemCode":"","package":"","packageDescriptions":[{"language":"NL","value":""}],"price":12,"shortDescriptions":[{"language":"NL","value":"<p>test change</p>\r\n"}],"shortName":"","sku":"conf-first-option-1","sources":[],"status":"A","suggestedPrice":0,"supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"unit":1},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[]},{"defaultProduct":{"costPrice":0,"descriptions":[{"language":"NL","value":""}],"eanCode":"","id":661190,"manufacturer":"","minimumQuantity":1,"names":[{"language":"NL","value":"My second option"}],"notes":[{"language":"NL","value":""}],"oemCode":"","package":"","packageDescriptions":[{"language":"NL","value":""}],"price":0,"shortDescriptions":[{"language":"NL","value":""}],"shortName":"","sku":"conf-second-option-2","sources":[],"status":"A","suggestedPrice":0,"supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"unit":1},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[]}],"messages":[],"total":2}}}}}},"404":{"description":"Get Options by Cluster lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:25:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"77b46b5a-6353-4512-86e0-ba98b6e83793"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [211] not found"},"example":["Parent Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Get Options by Cluster lookup key - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Order Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-order-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Order Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for an order address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81902"},"description":"Address Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Order Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"428"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:32:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f4778ede-9757-4f1e-9f18-bb9d66589804"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"julien@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Order Address by Id - 200":{"value":{"data":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"julien@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},"messages":[],"total":1}}}}}},"404":{"description":"Get Order Address by Id - 404 (order not found) / Get Order Address by Id - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:32:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4e308b90-bc3a-44ad-9fda-a01dd9941af1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Get Order Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819021] not found for [Order] with id [195]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Order Address by Id - 404 (order not found)":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Pricesheet by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-pricesheet-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Pricesheet by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/pricesheets/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve price sheet details by lookup key. The `expands` parameter can be used to retrieve the pricing for the price sheet.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"products,categories"},"description":"Optional. Use `products` and/ or `categories` to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved. \n\n[What is resource expanding?](#expanding-resources)"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-sonar/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Pricesheet by code - 200 (expands products, categories) / Get Pricesheet by code - 200 (without expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"573"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:34:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a2e71016-be26-435c-a957-cf10b4c792f6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"string","example":"Pricesheet 3A21"},"pricing":{"type":"array","items":{"type":"object","properties":{"category":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]},"id":{"type":"number","example":1779},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"CP"},"validFrom":{"type":"string","example":"May, 01 2022 00:00:00 +0000"},"validTo":{"type":"string","example":"December, 31 2022 00:00:00 +0000"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]}}},"product":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}]},"eanCode":{"type":"string","example":"0753759256211"},"id":{"type":"number","example":40364},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"}]},"oemCode":{"type":"string","example":"NCABD70005"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":599.95},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"SP"},"validFrom":{"type":"string","example":"May, 01 2022 00:00:00 +0000"},"validTo":{"type":"string","example":"December, 31 2022 00:00:00 +0000"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}]},"shortName":{"type":"string","example":"Edge 1050 FietsComputer"},"sku":{"type":"string","example":"NCABD70005"},"status":{"type":"string","example":"A"},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70005"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}}}},"example":[{"category":{"descriptions":[{"language":"NL","value":"Fiets"}],"id":1779,"names":[{"language":"NL","value":"Fiets"}],"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"Fiets"}]}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256211","id":40364,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"oemCode":"NCABD70005","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","taxPercentage":0.21,"unit":1}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256289","id":40362,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"oemCode":"NCABD70004","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1}}]},"shopId":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Pricesheet by code - 200 (expands products, categories)":{"value":{"data":{"code":"3A21","description":"","name":"Pricesheet 3A21","pricing":[{"category":{"descriptions":[{"language":"NL","value":"Fiets"}],"id":1779,"names":[{"language":"NL","value":"Fiets"}],"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"Fiets"}]}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256211","id":40364,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"oemCode":"NCABD70005","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","taxPercentage":0.21,"unit":1}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256289","id":40362,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"oemCode":"NCABD70004","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1}}],"shopId":1},"messages":[],"total":1}},"Get Pricesheet by code - 200 (without expands)":{"value":{"data":{"code":"3A21","description":"","name":"Pricesheet 3A21","pricing":[{"category":{"id":1779,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}},{"product":{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}},{"product":{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}}],"shopId":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Pricesheet by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:35:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7a2f7cfc-bdd1-4be1-8579-92c7e7d0f074"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12002},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet with id [158] not found"},"example":["Pricesheet with id [158] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12002"},"status":{"type":"number","example":404},"type":{"type":"string","example":"PricesheetNotFound"}}}}},"examples":{"Get Pricesheet by Id - 404":{"value":{"error":{"code":12002,"messages":["Pricesheet with id [158] not found"],"moreInfo":"https://www.propel.us/docs/errors/12002","status":404,"type":"PricesheetNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Pricesheets

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-pricesheets.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Pricesheets"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/pricesheets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all price sheets.

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Pricesheets - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"152"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:17:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"77246dc8-4d63-47f5-90c9-1ec5312adefb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"string","example":"Pricesheet 3A21"},"shopId":{"type":"number","example":1}}},"example":[{"code":"3A21","description":"","name":"Pricesheet 3A21","shopId":1},{"code":"3A22","description":"","name":"Pricesheet 3A22","shopId":1}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Pricesheets - 200":{"value":{"data":[{"code":"3A21","description":"","name":"Pricesheet 3A21","shopId":1},{"code":"3A22","description":"","name":"Pricesheet 3A22","shopId":1}],"messages":[],"total":2}}}}}}}}
>
  
</StatusCodes>

---

## Get Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,surcharges,costprices"}},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"1057"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:30:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"616cce76-17e9-4f12-a31e-6fc6b6815ca1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"costprices":{"type":"array","items":{},"example":[]},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"Schneider"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>blawn</p>\r\n"}}},"example":[{"language":"NL","value":"<p>blawn</p>\r\n"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"151203"}]},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"surcharges":{"type":"array","items":{},"example":[]},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product by Cluster lookup key and Product Id - 200":{"value":{"data":{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","sources":[{"language":"NL","source":"REST-API","sourceId":"151203"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:30:51 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"4a74b63f-ec87-46ca-8a59-a320886f7457"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707968] not found for the cluster with id [210]"},"example":["Cluster Product with id [707968] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Get Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707968] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve product details by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"expands","in":"query","schema":{"type":"string","example":"translation"},"description":"Optional. Use `translation` when retrieving translated fields in all lanugages. By default, only the default language of the product will be provided. [What is resource expanding?](#expanding-resources)"},{"name":"supplier","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `supplierCode`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2771"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:16:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"211845eb-9c56-4683-8ee7-e8af35583625"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product by Id - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Product by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"172"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:18:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"3b73cffc-5153-4eef-ba0d-33867d59d3fa"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with sourceId [40360] not found"},"example":["Product with sourceId [40360] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product by sourceId - 404":{"value":{"error":{"code":80006,"messages":["Product with sourceId [40360] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product Inventory By Warehouse

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-product-inventory-by-warehouse.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product Inventory By Warehouse"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupkey}/{key}/inventory/warehouses/{warehouseId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint gives cumulative product inventory data by searching on a lookup key and warehouse id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"},{"name":"warehouseId","in":"path","required":true,"schema":{"type":"string","example":"4"},"description":"Warehouse id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product Inventory By Warehouse - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 16:48:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5f5e44f4-b507-4b29-98a1-46758e32dc3f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":16},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"productId":{"type":"number","example":38952},"supplierQuantity":{"type":"number","example":3},"supplierReservedQuantity":{"type":"number","example":0},"totalQuantity":{"type":"number","example":19},"totalReservedQuantity":{"type":"number","example":0}}},"example":[{"localQuantity":16,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":3,"supplierReservedQuantity":0,"totalQuantity":19,"totalReservedQuantity":0}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product Inventory By Warehouse - 200":{"value":{"data":[{"localQuantity":16,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":3,"supplierReservedQuantity":0,"totalQuantity":19,"totalReservedQuantity":0}],"messages":[],"total":1}}}}}},"404":{"description":"Get Product Inventory By Warehouse - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 16:49:21 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e2c4820-7217-4d15-a8e2-37d5e57c604c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [59328] not found"},"example":["Product with id [59328] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product Inventory By Warehouse - 404":{"value":{"error":{"code":80006,"messages":["Product with id [59328] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-product-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product Inventory"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupkey}/{key}/inventory"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint gives cumulative product inventory data by searching on a lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product Inventory by Id - 200 / Get Product Inventory by Id - expands - 200 / Get Product Inventory by Id - 200 (reserved stock) / Get Product Inventory by Id - expands - 200 (reserved stock)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"1384"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 14:24:00 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":136},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"productId":{"type":"number","example":38952},"supplierQuantity":{"type":"number","example":54},"supplierReservedQuantity":{"type":"number","example":0},"totalQuantity":{"type":"number","example":190},"totalReservedQuantity":{"type":"number","example":0}}},"example":[{"localQuantity":136,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":54,"supplierReservedQuantity":0,"totalQuantity":190,"totalReservedQuantity":0}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product Inventory by Id - expands - 200":{"value":{"data":[{"balance":[{"companyId":0,"costPrice":0,"dateModified":"2022-03-09T10:49:54","id":16150,"location":"","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2022-02-21T12:55:27","id":16152,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T10:59:59","id":16157,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-03-09T10:46:25","id":16159,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:05:16","id":16160,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2022-02-16T22:05:17","id":16162,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:12:18","id":16164,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:12:19","id":16165,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:17:44","id":16168,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:17:44","id":16169,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:21:27","id":16172,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:21:28","id":16173,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:03:24","id":16176,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:03:24","id":16177,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:05:35","id":16180,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:05:35","id":16181,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:18:15","id":16184,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:18:15","id":16185,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0}],"localQuantity":133,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":38,"supplierReservedQuantity":0,"totalQuantity":171,"totalReservedQuantity":0}],"messages":[],"total":1}},"Get Product Inventory by Id - 200":{"value":{"data":[{"localQuantity":136,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":54,"supplierReservedQuantity":0,"totalQuantity":190,"totalReservedQuantity":0}],"messages":[],"total":1}},"Get Product Inventory by Id - 200 (reserved stock)":{"value":{"data":[{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"messages":["Completed"],"total":1}},"Get Product Inventory by Id - expands - 200 (reserved stock)":{"value":{"data":[{"balance":[{"companyId":227583,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16139,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":87,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2023-09-28T19:56:35","id":16140,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":16,"sku":"NCABD70004","supplier":"KERRIDGE","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16141,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":227237,"quantity":77,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:12:48","id":16142,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":82,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0}],"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"messages":["Completed"],"total":1}}}}}},"404":{"description":"Get Product Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Thu, 24 Mar 2022 09:29:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fb39c0b4-ff29-4330-8e2c-09c060175882"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [59328] not found"},"example":["Product with id [59328] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product Inventory by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [59328] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Products by Cluster lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-products-by-cluster-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Products by Cluster lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/products"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster products by cluster lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,surcharges,costprices"},"description":"Optional.  Use `translation` to retrieve the cluster products translations. Use `surcharges` to retrive cluster products surcharges etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Products by Cluster lookup key - 200 / Get Products by Cluster lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2079"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:28:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f377f9ff-0fe0-40f6-b28a-aafa2d513e5b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"Schneider"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>blawn</p>\r\n"}}},"example":[{"language":"NL","value":"<p>blawn</p>\r\n"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"unit":{"type":"number","example":1}}},"example":[{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","taxCode":"H","taxPercentage":21,"unit":1}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Products by Cluster lookup key - 200":{"value":{"data":[{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","taxCode":"H","taxPercentage":21,"unit":1}],"messages":[],"total":2}},"Get Products by Cluster lookup key - 200 (expands)":{"value":{"data":[{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","sources":[{"language":"NL","source":"REST-API","sourceId":"151203"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","sources":[{"language":"NL","source":"REST-API","sourceId":"151202"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1}],"messages":[],"total":2}}}}}},"404":{"description":"Get Products by Cluster lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:38:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"8b976a47-961b-40a4-98ce-7a1baab013c6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [211] not found"},"example":["Parent Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Get Products by Cluster lookup key - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get resource attribute by resource lookup key and attribute lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-resource-attribute-by-resource-lookup-key-and-attribute-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get resource attribute by resource lookup key and attribute lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes/{attributeLookupKey}/{attributeLookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a specific attribute for a resource identified by resource [lookup key](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys) and [attribute lookup key](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys). The `attributeClass` Query Param is useful to use when the attribute lookup key is `name` and the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with attribute lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"},{"name":"attributeLookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"attributeLookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get product attribute by product id and attribute id - 200 / Get product attribute by product id and attribute name/ class - 200 / Get user attribute by user id and attribute name/ class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"137"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:21:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"556612fa-7597-4b90-b8ac-2e4a90e90604"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":671},"inherited":{"type":"boolean","example":false},"name":{"type":"string","example":"MATERIAAL_FRAME"},"type":{"type":"string","example":"text"},"value":{"example":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}],"anyOf":[{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":false},"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Leather"}}},"example":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},{"type":"string","example":"Y"}]}}},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Get product attribute by product id and attribute id - 200":{"value":{"data":{"class":"product","id":671,"name":"MATERIAAL_FRAME","type":"text","value":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},"messages":["Completed"],"total":1}},"Get product attribute by product id and attribute name/ class - 200":{"value":{"data":{"class":"product","id":671,"name":"MATERIAAL_FRAME","type":"text","value":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},"messages":["Completed"],"total":1}},"Get user attribute by user id and attribute name/ class - 200":{"value":{"data":{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},"messages":["Completed"],"total":1}}}}}},"404":{"description":"Get product attribute by product id and attribute name/ class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"202"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:20:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"3badf180-4f37-4c65-aa7d-80f7a619cf69"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with name [FRAME] and attributeClass [product] not found."},"example":["Attribute with name [FRAME] and attributeClass [product] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Get product attribute by product id and attribute name/ class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [FRAME] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get resource attributes by resource lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-resource-attributes-by-resource-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get resource attributes by resource lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves all attributes for a resource identified by its [lookup key](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys). Results will be [paginated](/reference/legacy/rest-sonar/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.  
A resource can be a product, category, user or usergroup.

## Response fields

| **Name** | **Description** |
| --- | --- |
| `id` | Attribute Id |
| `name` | Attribute name |
| `type` | Type of the value of the attribute |
| `class` | Attribute class |
| `value` | Attribute value for the product. Depends on the type. |
| `inherited` | Boolean. Indicates whether the value is directly set on the product or inherited from a parent resource. For `text` and `list` type attributes, `inherited` is part of the localized string for each language. |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number"},{"name":"offset","in":"query","schema":{"type":"string","example":"50"},"description":"Number of results per page"},{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-sonar/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get product attributes by product id - 200 (with results) / Get product attributes by product id - 200 (no results) / Get user attributes by user id - 200 / Get usergroup attributes by usergroup id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"4176"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:11:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8ef1f77a-fa1c-402e-a90c-9761af2cbf4b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":11},"inherited":{"type":"boolean","example":true},"name":{"type":"string","example":"PROPELLOR_PLUSPUNT_1"},"type":{"type":"string","example":"text"},"value":{"example":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}],"anyOf":[{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Pluspunt test NL"}}},"example":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"type":"string","example":"N"},{"type":"number","example":0},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"string","example":""},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"number","example":0},{"type":"number","example":0}]}}},"example":[{"class":"product","id":11,"name":"PROPELLOR_PLUSPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"class":"product","id":12,"name":"PROPELLOR_PLUSPUNT_2","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel is compact in te klappen zodat je hem gemakkelijk meeneemt."}]},{"class":"product","id":13,"name":"PROPELLOR_PLUSPUNT_3","type":"text","value":[]},{"class":"product","id":15,"name":"PROPELLOR_PLUSPUNT_4","type":"text","value":[]},{"class":"product","id":16,"name":"PROPELLOR_PLUSPUNT_5","type":"text","value":[]},{"class":"product","id":17,"name":"PROPELLOR_PLUSPUNT_6","type":"text","value":[]},{"class":"product","id":18,"name":"PROPELLOR_PLUSPUNT_7","type":"text","value":[]},{"class":"product","id":19,"name":"PROPELLOR_PLUSPUNT_8","type":"text","value":[]},{"class":"product","id":20,"name":"PROPELLOR_MINPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel heeft geen verstelbare rugleuning."}]},{"class":"product","id":21,"name":"PROPELLOR_MINPUNT_2","type":"text","value":[]},{"class":"product","id":22,"name":"PROPELLOR_MINPUNT_3","type":"text","value":[]},{"class":"product","id":23,"name":"PROPELLOR_MINPUNT_4","type":"text","value":[]},{"class":"product","id":24,"name":"PROPELLOR_MINPUNT_5","type":"text","value":[]},{"class":"product","id":25,"name":"PROPELLOR_MINPUNT_6","type":"text","value":[]},{"class":"product","id":26,"name":"PROPELLOR_MINPUNT_7","type":"text","value":[]},{"class":"product","id":27,"name":"PROPELLOR_MINPUNT_8","type":"text","value":[]},{"class":"product","id":28,"name":"PROPELLOR_LABEL_1","type":"text","value":[]},{"class":"product","id":29,"name":"PROPELLOR_LABEL_2","type":"text","value":[]},{"class":"product","id":45,"name":"META_DESCRIPTION_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Buy your {product_name} at {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"FR","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"NL","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."}]},{"class":"product","id":46,"name":"META_TITLE_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Shop your {product_name , 40} | {shop_name}"},{"inherited":true,"language":"FR","value":"Koop uw {product_name , 40} | {shop_name}"},{"inherited":true,"language":"NL","value":"Koop uw {product_name , 40} | {shop_name}"}]},{"class":"product","id":66,"inherited":true,"name":"PROPELLOR_SALE","type":"enum","value":"N"},{"class":"product","id":67,"inherited":true,"name":"VALUEPOINTS_WAARDE","type":"decimal","value":0},{"class":"product","id":68,"name":"MATERIAAL_BINNENTENT","type":"text","value":[]},{"class":"product","id":73,"name":"BESTAND_TEGEN","type":"text","value":[]},{"class":"product","id":75,"name":"CAPACITEIT","type":"text","value":[]},{"class":"product","id":77,"name":"BREEDTE","type":"text","value":[]},{"class":"product","id":78,"name":"GEWICHT","type":"text","value":[]},{"class":"product","id":82,"name":"DIEPTE","type":"text","value":[]},{"class":"product","id":95,"name":"HOOGTE","type":"text","value":[]},{"class":"product","id":121,"inherited":true,"name":"SONAR_WATERPROOF","type":"enum","value":""},{"class":"product","id":139,"name":"SHOP_IN_KLEUR","type":"text","value":[]},{"class":"product","id":140,"name":"SHOP_IN_SERIE","type":"text","value":[]},{"class":"product","id":164,"name":"PROPELLOR_KLEUR","type":"text","value":[]},{"class":"product","id":165,"name":"PROPELLOR_MAAT","type":"text","value":[]},{"class":"product","id":167,"name":"DELIVERY_PROMISE_A","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":168,"name":"DELIVERY_PROMISE_B","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":169,"name":"DELIVERY_PROMISE_C","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"class":"product","id":170,"name":"DELIVERY_PROMISE_D","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"class":"product","id":171,"name":"DELIVERY_PROMISE_E","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"class":"product","id":172,"name":"DELIVERY_PROMISE_F","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"class":"product","id":173,"name":"DELIVERY_PROMISE_G","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"class":"product","id":174,"name":"DELIVERY_PROMISE_H","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"class":"product","id":175,"name":"DELIVERY_PROMISE_I","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"class":"product","id":176,"name":"DELIVERY_PROMISE_J","type":"text","value":[]},{"class":"product","id":177,"name":"DELIVERY_PROMISE_K","type":"text","value":[]},{"class":"product","id":179,"name":"PROPELLOR_PRODUCT_FORMULA","type":"text","value":[]},{"class":"product","id":193,"name":"PROPELLOR_PACKAGE","type":"text","value":[]},{"class":"product","id":641,"inherited":true,"name":"NUMERIC_DEMO","type":"integer","value":0},{"class":"product","id":642,"inherited":true,"name":"DECIMAL_DEMO","type":"decimal","value":0},{"class":"product","id":643,"name":"DATETIME_DEMO","type":"datetime"}]},"end":{"type":"number","example":50},"itemsFound":{"type":"number","example":108},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":50},"page":{"type":"number","example":1},"pages":{"type":"number","example":3},"start":{"type":"number","example":1},"total":{"type":"number","example":50}}},"examples":{"Get product attributes by product id - 200 (no results)":{"value":{"data":[],"itemsFound":108,"messages":["Completed"],"offset":50,"page":5,"pages":3,"total":1}},"Get product attributes by product id - 200 (with results)":{"value":{"data":[{"class":"product","id":11,"name":"PROPELLOR_PLUSPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"class":"product","id":12,"name":"PROPELLOR_PLUSPUNT_2","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel is compact in te klappen zodat je hem gemakkelijk meeneemt."}]},{"class":"product","id":13,"name":"PROPELLOR_PLUSPUNT_3","type":"text","value":[]},{"class":"product","id":15,"name":"PROPELLOR_PLUSPUNT_4","type":"text","value":[]},{"class":"product","id":16,"name":"PROPELLOR_PLUSPUNT_5","type":"text","value":[]},{"class":"product","id":17,"name":"PROPELLOR_PLUSPUNT_6","type":"text","value":[]},{"class":"product","id":18,"name":"PROPELLOR_PLUSPUNT_7","type":"text","value":[]},{"class":"product","id":19,"name":"PROPELLOR_PLUSPUNT_8","type":"text","value":[]},{"class":"product","id":20,"name":"PROPELLOR_MINPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel heeft geen verstelbare rugleuning."}]},{"class":"product","id":21,"name":"PROPELLOR_MINPUNT_2","type":"text","value":[]},{"class":"product","id":22,"name":"PROPELLOR_MINPUNT_3","type":"text","value":[]},{"class":"product","id":23,"name":"PROPELLOR_MINPUNT_4","type":"text","value":[]},{"class":"product","id":24,"name":"PROPELLOR_MINPUNT_5","type":"text","value":[]},{"class":"product","id":25,"name":"PROPELLOR_MINPUNT_6","type":"text","value":[]},{"class":"product","id":26,"name":"PROPELLOR_MINPUNT_7","type":"text","value":[]},{"class":"product","id":27,"name":"PROPELLOR_MINPUNT_8","type":"text","value":[]},{"class":"product","id":28,"name":"PROPELLOR_LABEL_1","type":"text","value":[]},{"class":"product","id":29,"name":"PROPELLOR_LABEL_2","type":"text","value":[]},{"class":"product","id":45,"name":"META_DESCRIPTION_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Buy your {product_name} at {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"FR","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"NL","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."}]},{"class":"product","id":46,"name":"META_TITLE_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Shop your {product_name , 40} | {shop_name}"},{"inherited":true,"language":"FR","value":"Koop uw {product_name , 40} | {shop_name}"},{"inherited":true,"language":"NL","value":"Koop uw {product_name , 40} | {shop_name}"}]},{"class":"product","id":66,"inherited":true,"name":"PROPELLOR_SALE","type":"enum","value":"N"},{"class":"product","id":67,"inherited":true,"name":"VALUEPOINTS_WAARDE","type":"decimal","value":0},{"class":"product","id":68,"name":"MATERIAAL_BINNENTENT","type":"text","value":[]},{"class":"product","id":73,"name":"BESTAND_TEGEN","type":"text","value":[]},{"class":"product","id":75,"name":"CAPACITEIT","type":"text","value":[]},{"class":"product","id":77,"name":"BREEDTE","type":"text","value":[]},{"class":"product","id":78,"name":"GEWICHT","type":"text","value":[]},{"class":"product","id":82,"name":"DIEPTE","type":"text","value":[]},{"class":"product","id":95,"name":"HOOGTE","type":"text","value":[]},{"class":"product","id":121,"inherited":true,"name":"SONAR_WATERPROOF","type":"enum","value":""},{"class":"product","id":139,"name":"SHOP_IN_KLEUR","type":"text","value":[]},{"class":"product","id":140,"name":"SHOP_IN_SERIE","type":"text","value":[]},{"class":"product","id":164,"name":"PROPELLOR_KLEUR","type":"text","value":[]},{"class":"product","id":165,"name":"PROPELLOR_MAAT","type":"text","value":[]},{"class":"product","id":167,"name":"DELIVERY_PROMISE_A","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":168,"name":"DELIVERY_PROMISE_B","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":169,"name":"DELIVERY_PROMISE_C","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"class":"product","id":170,"name":"DELIVERY_PROMISE_D","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"class":"product","id":171,"name":"DELIVERY_PROMISE_E","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"class":"product","id":172,"name":"DELIVERY_PROMISE_F","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"class":"product","id":173,"name":"DELIVERY_PROMISE_G","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"class":"product","id":174,"name":"DELIVERY_PROMISE_H","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"class":"product","id":175,"name":"DELIVERY_PROMISE_I","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"class":"product","id":176,"name":"DELIVERY_PROMISE_J","type":"text","value":[]},{"class":"product","id":177,"name":"DELIVERY_PROMISE_K","type":"text","value":[]},{"class":"product","id":179,"name":"PROPELLOR_PRODUCT_FORMULA","type":"text","value":[]},{"class":"product","id":193,"name":"PROPELLOR_PACKAGE","type":"text","value":[]},{"class":"product","id":641,"inherited":true,"name":"NUMERIC_DEMO","type":"integer","value":0},{"class":"product","id":642,"inherited":true,"name":"DECIMAL_DEMO","type":"decimal","value":0},{"class":"product","id":643,"name":"DATETIME_DEMO","type":"datetime"}],"end":50,"itemsFound":108,"messages":["Completed"],"offset":50,"page":1,"pages":3,"start":1,"total":50}},"Get user attributes by user id - 200":{"value":{"data":[{"class":"user","id":47,"inherited":true,"name":"REKENING","type":"decimal","value":1.6},{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},{"class":"user","id":49,"inherited":true,"name":"CONTANT","type":"decimal","value":0},{"class":"user","id":50,"inherited":true,"name":"SHOW_CONTANT","type":"enum","value":"Y"},{"class":"user","id":54,"inherited":true,"name":"MULTISAFEPAY_IDEAL","type":"decimal","value":0},{"class":"user","id":63,"inherited":true,"name":"SHOW_MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":64,"inherited":true,"name":"MULTISAFEPAY_MASTERCARD","type":"decimal","value":0},{"class":"user","id":65,"inherited":true,"name":"SHOW_MULTISAFEPAY_MASTERCARD","type":"enum","value":"N"},{"class":"user","id":125,"inherited":true,"name":"MULTISAFEPAY_VISA","type":"decimal","value":99999.99999},{"class":"user","id":126,"inherited":true,"name":"SHOW_MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":127,"inherited":true,"name":"MULTISAFEPAY_AMERICAN EXPRESS","type":"decimal","value":99999.99999},{"class":"user","id":128,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":129,"inherited":true,"name":"PAYPAL","type":"decimal","value":99999.99999},{"class":"user","id":130,"inherited":true,"name":"SHOW_PAYPAL","type":"enum","value":"Y"},{"class":"user","id":131,"inherited":true,"name":"MULTISAFEPAY_PAYAFTER","type":"decimal","value":99999.99999},{"class":"user","id":132,"inherited":true,"name":"SHOW_MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":133,"inherited":true,"name":"INCASSO","type":"decimal","value":99999.99999},{"class":"user","id":134,"inherited":true,"name":"SHOW_INCASSO","type":"enum","value":"Y"},{"class":"user","id":629,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRECTBANK","type":"enum","value":"Y"},{"class":"user","id":630,"inherited":true,"name":"SHOW_MULTISAFEPAY_MISTERCASH","type":"enum","value":"Y"},{"class":"user","id":631,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRDEB","type":"enum","value":"Y"},{"class":"user","id":632,"inherited":true,"name":"SHOW_MULTISAFEPAY_GIROPAY","type":"enum","value":"Y"},{"class":"user","id":633,"inherited":true,"name":"SHOW_MULTISAFEPAY_BANKTRANS","type":"enum","value":"Y"},{"class":"user","id":634,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMEX","type":"enum","value":"Y"},{"class":"user","id":635,"inherited":true,"name":"SHOW_MULTISAFEPAY_SOFORT","type":"enum","value":"Y"},{"class":"user","id":636,"inherited":true,"name":"SHOW_MULTISAFEPAY_MAESTRO","type":"enum","value":"Y"},{"class":"user","id":141,"inherited":true,"name":"mobileapp.REKENING","type":"enum","value":"N"},{"class":"user","id":142,"inherited":true,"name":"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":143,"inherited":true,"name":"mobileapp.MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":144,"inherited":true,"name":"mobileapp.MULTISAFEPAY_MASTERCARD","type":"enum","value":"Y"},{"class":"user","id":145,"inherited":true,"name":"mobileapp.MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":146,"inherited":true,"name":"mobileapp.MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":153,"inherited":true,"name":"CREDIT_LIMIT","type":"decimal","value":0},{"class":"user","id":154,"inherited":true,"name":"CREDIT_LIMIT_INTERVAL","type":"enum","value":"month"},{"class":"user","id":155,"inherited":true,"name":"FI_DEFAULT_BUDGET_GROUP","type":"enum","value":"8010"},{"class":"user","id":178,"name":"PROPELLOR_USER_FORMULA","type":"text","value":[]},{"class":"user","id":182,"inherited":true,"name":"EDIT_DELIVERY_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":183,"inherited":true,"name":"EDIT_INVOICE_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":184,"inherited":true,"name":"EC.viewUsergroupOrders","type":"enum","value":"N"},{"class":"user","id":626,"inherited":true,"name":"PAY_WITH_CREDITPOINTS","type":"enum","value":"N"}],"end":40,"itemsFound":40,"messages":["Completed"],"offset":50,"page":1,"pages":1,"start":1,"total":40}},"Get usergroup attributes by usergroup id - 200":{"value":{"data":[{"class":"user","id":47,"inherited":true,"name":"REKENING","type":"decimal","value":1.6},{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},{"class":"user","id":49,"inherited":true,"name":"CONTANT","type":"decimal","value":0},{"class":"user","id":50,"inherited":true,"name":"SHOW_CONTANT","type":"enum","value":"Y"},{"class":"user","id":54,"inherited":true,"name":"MULTISAFEPAY_IDEAL","type":"decimal","value":0},{"class":"user","id":63,"inherited":true,"name":"SHOW_MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":64,"inherited":true,"name":"MULTISAFEPAY_MASTERCARD","type":"decimal","value":0},{"class":"user","id":65,"inherited":true,"name":"SHOW_MULTISAFEPAY_MASTERCARD","type":"enum","value":"N"},{"class":"user","id":125,"inherited":true,"name":"MULTISAFEPAY_VISA","type":"decimal","value":99999.99999},{"class":"user","id":126,"inherited":true,"name":"SHOW_MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":127,"inherited":true,"name":"MULTISAFEPAY_AMERICAN EXPRESS","type":"decimal","value":99999.99999},{"class":"user","id":128,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":129,"inherited":true,"name":"PAYPAL","type":"decimal","value":99999.99999},{"class":"user","id":130,"inherited":true,"name":"SHOW_PAYPAL","type":"enum","value":"Y"},{"class":"user","id":131,"inherited":true,"name":"MULTISAFEPAY_PAYAFTER","type":"decimal","value":99999.99999},{"class":"user","id":132,"inherited":true,"name":"SHOW_MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":133,"inherited":true,"name":"INCASSO","type":"decimal","value":99999.99999},{"class":"user","id":134,"inherited":true,"name":"SHOW_INCASSO","type":"enum","value":"Y"},{"class":"user","id":629,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRECTBANK","type":"enum","value":"Y"},{"class":"user","id":630,"inherited":true,"name":"SHOW_MULTISAFEPAY_MISTERCASH","type":"enum","value":"Y"},{"class":"user","id":631,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRDEB","type":"enum","value":"Y"},{"class":"user","id":632,"inherited":true,"name":"SHOW_MULTISAFEPAY_GIROPAY","type":"enum","value":"Y"},{"class":"user","id":633,"inherited":true,"name":"SHOW_MULTISAFEPAY_BANKTRANS","type":"enum","value":"Y"},{"class":"user","id":634,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMEX","type":"enum","value":"Y"},{"class":"user","id":635,"inherited":true,"name":"SHOW_MULTISAFEPAY_SOFORT","type":"enum","value":"Y"},{"class":"user","id":636,"inherited":true,"name":"SHOW_MULTISAFEPAY_MAESTRO","type":"enum","value":"Y"},{"class":"user","id":141,"inherited":true,"name":"mobileapp.REKENING","type":"enum","value":"N"},{"class":"user","id":142,"inherited":true,"name":"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":143,"inherited":true,"name":"mobileapp.MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":144,"inherited":true,"name":"mobileapp.MULTISAFEPAY_MASTERCARD","type":"enum","value":"Y"},{"class":"user","id":145,"inherited":true,"name":"mobileapp.MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":146,"inherited":true,"name":"mobileapp.MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":153,"inherited":true,"name":"CREDIT_LIMIT","type":"decimal","value":0},{"class":"user","id":154,"inherited":true,"name":"CREDIT_LIMIT_INTERVAL","type":"enum","value":"month"},{"class":"user","id":155,"inherited":true,"name":"FI_DEFAULT_BUDGET_GROUP","type":"enum","value":"8010"},{"class":"user","id":178,"name":"PROPELLOR_USER_FORMULA","type":"text","value":[]},{"class":"user","id":182,"inherited":true,"name":"EDIT_DELIVERY_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":183,"inherited":true,"name":"EDIT_INVOICE_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":184,"inherited":true,"name":"EC.viewUsergroupOrders","type":"enum","value":"N"},{"class":"user","id":626,"inherited":true,"name":"PAY_WITH_CREDITPOINTS","type":"enum","value":"N"}],"end":40,"itemsFound":40,"messages":["Completed"],"offset":50,"page":1,"pages":1,"start":1,"total":40}}}}}},"400":{"description":"Get product attributes by product id - 400 (invalid page or offset)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 11:51:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d5416483-9bbf-41e9-a16c-5661f7b24719"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10015},"messages":{"type":"array","items":{"type":"string","example":"Offset cannot be more than 100"},"example":["Offset cannot be more than 100"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10015"},"status":{"type":"number","example":400},"type":{"type":"string","example":"PaginatedResponseException"}}}}},"examples":{"Get product attributes by product id - 400 (invalid page or offset)":{"value":{"error":{"code":10015,"messages":["Offset cannot be more than 100"],"moreInfo":"https://www.propel.us/docs/errors/10015","status":400,"type":"PaginatedResponseException"}}}}}}},"404":{"description":"Get product attributes by product id - 404 / Get user attributes by user id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:09:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"43c4015f-9ea5-4ff9-b2c2-a243179db9d2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10009},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Product] with id [372212] not found."},"example":["Parent resource [Product] with id [372212] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10009"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentProductNotFound"}}}}},"examples":{"Get product attributes by product id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with id [372212] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}},"Get user attributes by user id - 404":{"value":{"error":{"code":90008,"messages":["Parent resource [User] with id [14123] not found."],"moreInfo":"https://www.propel.us/docs/errors/90008","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Shipments

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-shipments.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Shipments"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/shipments"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all order shipments.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={
    [
      {
          "name": "lookupKey",
          "in": "path",
          "required": true,
          "schema": {
              "type": "string",
              "example": "id"
          },
          "description": "Use `id` or `externalId`"
      },
      {
          "name": "lookupValue",
          "in": "path",
          "required": true,
          "schema": {
              "type": "string",
              "example": "195"
          },
          "description": "The `id` or `externalId` of the order"
      }
  ]
}>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={
    {
      "200": {
          "description": "Get Shipments - 200",
          "headers": {
              "Alt-Svc": {
                  "schema": {
                      "type": "string",
                      "example": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
                  }
              },
              "Via": {
                  "schema": {
                      "type": "string",
                      "example": "1.1 google, 1.1 google"
                  }
              },
              "alt-svc": {
                  "schema": {
                      "type": "string",
                      "example": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
                  }
              },
              "content-length": {
                  "schema": {
                      "type": "string",
                      "example": "155"
                  }
              },
              "date": {
                  "schema": {
                      "type": "string",
                      "example": "Thu, 28 Apr 2022 17:38:39 GMT"
                  }
              },
              "return-format": {
                  "schema": {
                      "type": "string",
                      "example": "json"
                  }
              },
              "server": {
                  "schema": {
                      "type": "string",
                      "example": "istio-envoy"
                  }
              },
              "x-request-id": {
                  "schema": {
                      "type": "string",
                      "example": "e8d06185-f61c-414e-a2a0-5b7fda9e6974"
                  }
              }
          },
          "content": {
              "application/json": {
                  "schema": {
                      "type": "object",
                      "properties": {
                          "data": {
                              "type": "array",
                              "items": {
                                  "type": "object",
                                  "properties": {
                                      "id": {
                                          "type": "number",
                                          "example": 49638
                                      },
                                      "orderId": {
                                          "type": "number",
                                          "example": 20216928
                                      },
                                      "deliveryId": {
                                          "type": "string",
                                          "example": "383C75F5-E3FB-4831-B0692E13AF02B959"
                                      },
                                      "colli": {
                                          "type": "number",
                                          "example": 0
                                      },
                                      "itemCount": {
                                          "type": "number",
                                          "example": 3
                                      },
                                      "trackTrace": {
                                          "type": "string",
                                          "example": "tt123"
                                      },
                                      "notes": {
                                          "type": "string",
                                          "example": ""
                                      },
                                      "shipDate": {
                                          "type": "string",
                                          "example": ""
                                      },
                                      "deliveryDate": {
                                          "type": "string",
                                          "example": "2025-09-09T00:00:00"
                                      },
                                      "exportDate": {
                                          "type": "string",
                                          "example": "2025-09-26T14:09:48"
                                      },
                                      "exportMessage": {
                                          "type": "string",
                                          "example": "Afas dispatch ID: 70031903"
                                      },
                                      "supplier": {
                                          "type": "string",
                                          "example": "INTERN"
                                      },
                                      "carrierName": {
                                          "type": "string",
                                          "example": "DHL"
                                      },
                                      "items": {
                                          "type": "array",
                                          "items": {
                                              "type": "object",
                                              "properties": {
                                                  "id": {
                                                      "type": "number",
                                                      "example": 217480
                                                  },
                                                  "orderitemId": {
                                                      "type": "number",
                                                      "example": 82768
                                                  },
                                                  "sku": {
                                                      "type": "string",
                                                      "example": "Q832029"
                                                  },
                                                  "supplierCode": {
                                                      "type": "string",
                                                      "example": "832029"
                                                  },
                                                  "name": {
                                                      "type": "string",
                                                      "example": "Elastiek Standard Rubber Bands 12 40x1.5mm 500gr 3300 stuks bruin"
                                                  },
                                                  "quantity": {
                                                      "type": "number",
                                                      "example": 1
                                                  },
                                                  "delivered": {
                                                      "type": "number",
                                                      "example": 1
                                                  },
                                                  "cancelled": {
                                                      "type": "number",
                                                      "example": 0
                                                  },
                                                  "confirmed": {
                                                      "type": "number",
                                                      "example": 0
                                                  },
                                                  "supplier": {
                                                      "type": "string",
                                                      "example": "INTERN"
                                                  }
                                              }
                                          }
                                      }
                                  }
                              }
                          },
                          "messages": {
                              "type": "array",
                              "items": {},
                              "example": []
                          },
                          "total": {
                              "type": "number",
                              "example": 1
                          }
                      }
                  },
                  "examples": {
                      "Get Shipments - 200": {
                        "value": {
                          "data": [
                            {
                              "colli": 0,
                              "deliveryId": "383C75F5-E3FB-4831-B0692E13AF02B959",
                              "itemCount": 3,
                              "trackTrace": "tt123",
                              "notes": "",
                              "orderId": 20216928,
                              "shipDate": "",
                              "items": [
                                {
                                  "cancelled": 0,
                                  "delivered": 1,
                                  "sku": "Q832029",
                                  "supplierCode": "832029",
                                  "orderitemId": 82768,
                                  "confirmed": 0,
                                  "name": "Elastiek Standard Rubber Bands 12 40x1.5mm 500gr 3300 stuks bruin",
                                  "id": 217480,
                                  "quantity": 1,
                                  "supplier": "INTERN"
                                },
                                {
                                  "cancelled": 0,
                                  "delivered": 5,
                                  "sku": "Q891668",
                                  "supplierCode": "891668",
                                  "orderitemId": 82769,
                                  "confirmed": 0,
                                  "name": "Vaatwastabletten Sun Pro Formula Classic 188 stuks",
                                  "id": 217481,
                                  "quantity": 5,
                                  "supplier": "INTERN"
                                },
                                {
                                  "cancelled": 0,
                                  "delivered": 3,
                                  "sku": "Q899985",
                                  "supplierCode": "899985",
                                  "orderitemId": 82770,
                                  "confirmed": 0,
                                  "name": "Thee Lipton Refresh forest fruits 100x1.5gr",
                                  "id": 217482,
                                  "quantity": 3,
                                  "supplier": "INTERN"
                                }
                              ],
                              "id": 49638,
                              "deliveryDate": "2025-09-09T00:00:00",
                              "exportMessage": "Afas dispatch ID: 70031903",
                              "exportDate": "2025-09-26T14:09:48",
                              "supplier": "INTERN",
                              "carrierName": "DHL"
                            }
                          ],
                          "messages": [],
                          "total": 1
                        }
                      }
                  }
              }
          }
      },
      "404": {
          "description": "Get Shipments - 404",
          "headers": {
              "Alt-Svc": {
                  "schema": {
                      "type": "string",
                      "example": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
                  }
              },
              "Via": {
                  "schema": {
                      "type": "string",
                      "example": "1.1 google, 1.1 google"
                  }
              },
              "alt-svc": {
                  "schema": {
                      "type": "string",
                      "example": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"
                  }
              },
              "content-length": {
                  "schema": {
                      "type": "string",
                      "example": "155"
                  }
              },
              "date": {
                  "schema": {
                      "type": "string",
                      "example": "Thu, 28 Apr 2022 17:38:39 GMT"
                  }
              },
              "return-format": {
                  "schema": {
                      "type": "string",
                      "example": "json"
                  }
              },
              "server": {
                  "schema": {
                      "type": "string",
                      "example": "istio-envoy"
                  }
              },
              "x-request-id": {
                  "schema": {
                      "type": "string",
                      "example": "e8d06185-f61c-414e-a2a0-5b7fda9e6974"
                  }
              }
          },
          "content": {
              "application/json": {
                  "schema": {
                      "type": "object",
                      "properties": {
                          "error": {
                              "type": "object",
                              "properties": {
                                  "code": {
                                      "type": "number",
                                      "example": 15001
                                  },
                                  "messages": {
                                      "type": "array",
                                      "items": {
                                          "type": "string",
                                          "example": "Order with id [295] not found"
                                      },
                                      "example": [
                                          "Order with id [295] not found"
                                      ]
                                  },
                                  "moreInfo": {
                                      "type": "string",
                                      "example": "https://www.propel.us/docs/errors/15001"
                                  },
                                  "status": {
                                      "type": "number",
                                      "example": 404
                                  },
                                  "type": {
                                      "type": "string",
                                      "example": "OrderNotFound"
                                  }
                              }
                          }
                      }
                  },
                  "examples": {
                      "Get Shipments - 404": {
                          "value": {
                              "error": {
                                  "code": 15001,
                                  "messages": [
                                      "Order with id [295] not found"
                                  ],
                                  "moreInfo": "https://www.propel.us/docs/errors/15001",
                                  "status": 404,
                                  "type": "OrderNotFound"
                              }
                          }
                      }
                  }
              }
          }
      }
  }
}>
  
</StatusCodes>

---

## Get User Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-user-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a user address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"462"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:54:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get User Address by Id - 404 (address not found) / Get User Address by Id - 404 (user not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 20:55:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ec3d49c0-0e66-43d0-b954-753d8bf0fb70"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":90006},"messages":{"type":"array","items":{"type":"string","example":"Address with id [819081] not found for [User] with id [14760]"},"example":["Address with id [819081] not found for [User] with id [14760]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/90006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AddressNotFound"}}}}},"examples":{"Get User Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819081] not found for [User] with id [14760]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get User Address by Id - 404 (user not found)":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get User Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-user-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all user addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User Delivery Addresses by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"464"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7ba7b832-624b-49ee-ba0d-993be90732a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User Delivery Addresses by Id - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}],"messages":[],"total":1}}}}}},"404":{"description":"Get User Delivery Addresses by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ac58aef4-a7f5-426b-a374-170218dffed2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Get User Delivery Addresses by Id - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve user details by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources,parent"},"description":"Use `expands` as a query parameter to fetch additional information for users like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a user can be a resource of type `usergroup`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User by  id - 200 / Get User by lookup key - 200 (expands: sources, parent)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"707"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:27:33 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"fullName":{"type":"string","example":"Miles McCoy"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14760},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":"Whitepaper Download"},"defaultobjectId":{"type":"number","example":221701},"department":{"type":"string","example":""},"id":{"type":"number","example":119},"inheritOrderList":{"type":"string","example":"Y"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Whitepaper Download"},"notes":{"type":"string","example":""},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"userManagerId":{"type":"string","example":""}}},"phone":{"type":"string","example":"0032445888"},"sources":{"type":"array","items":{},"example":[]},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."},"vatNumber":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User by  id - 200":{"value":{"data":{"abbreviation":"MM","company":"","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","firstName":"Miles","fullName":"Miles McCoy","gender":"M","id":14760,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","ssn":"","title":"Mr.","vatNumber":""},"messages":[],"total":1}},"Get User by lookup key - 200 (expands: sources, parent)":{"value":{"data":{"abbreviation":"KP","company":"Propellor","dateOfBirth":"July, 22 1986 00:00:00 +0000","debtorId":"000002","email":"info@propellor.eu","firstName":"Karl","fullName":"Karl Pflieger","gender":"M","id":14550,"lastName":"Pflieger","login":"k.pflieger","middleName":"","mobile":"06123456789","parent":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Whitepaper Download","defaultobjectId":221701,"department":"","id":119,"inheritOrderList":"Y","inheritProductList":"Y","name":"Whitepaper Download","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"userManagerId":""},"phone":"","sources":[],"ssn":"","title":"Mr","vatNumber":""},"messages":[],"total":1}}}}}},"400":{"description":"Get User by ld - 400 (invalid lookupkey)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:27:46 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e32401da-1c99-40c7-a60a-039ff9b0246f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get User by ld - 400 (invalid lookupkey)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:26:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4ac42aa6-87c5-41e1-9034-d1b09fe5a0da"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with id [146221] not found"},"example":["User with id [146221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Get User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with id [146221] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-usergroup-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a usergroup address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"462"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:54:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get Usergroup Address by Id - 404 (address not found) / Get Usergroup Address by Id - 404 (usergroup not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 20:56:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e3114dc-c91a-4d93-8750-fafdee3ea687"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":90006},"messages":{"type":"array","items":{"type":"string","example":"Address with id [819181] not found for [Usergroup] with id [122]"},"example":["Address with id [819181] not found for [Usergroup] with id [122]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/90006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AddressNotFound"}}}}},"examples":{"Get Usergroup Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819181] not found for [Usergroup] with id [122]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Usergroup Address by Id - 404 (usergroup not found)":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-usergroup-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all usergroup addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup Delivery Addresses by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"464"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7ba7b832-624b-49ee-ba0d-993be90732a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup Delivery Addresses by Id - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}],"messages":[],"total":1}}}}}},"404":{"description":"Get Usergroup Delivery Addresses by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ac58aef4-a7f5-426b-a374-170218dffed2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Get Usergroup Delivery Addresses by Id - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/get-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve usergroup details by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for usergroups like sources, etc.\n\n`sources`: if the `expands` parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup by Id - 200 / Get Usergroup by lookup key - 200 (expands: sources)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"348"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:29:14 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":""},"defaultobjectId":{"example":"","anyOf":[{"type":"string","example":""},{"type":"number","example":221701}]},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"userManagerId":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup by Id - 200":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","defaultobjectId":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},"messages":[],"total":1}},"Get Usergroup by lookup key - 200 (expands: sources)":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Whitepaper Download","defaultobjectId":221701,"department":"","id":119,"inheritOrderList":"Y","inheritProductList":"Y","name":"Whitepaper Download","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"userManagerId":""},"messages":[],"total":1}}}}}},"400":{"description":"Get Usergroup by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:21:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5fa94d0-251c-4653-ae69-8869c77db00f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Usergroup by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Usergroup by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:20:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"50d45de3-d8b4-4c73-a2c7-6c5208255c1f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21315] not found"},"example":["Usergroup with id [21315] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Get Usergroup by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21315] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## REST SonarCloud Reference

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar

# REST SonarCloud Reference

<LegacyBanner />

Complete endpoint reference for the Propeller REST SonarCloud variant API. Browse endpoints by resource using the sidebar. This reference is maintained for partners with existing SonarCloud implementations. New projects should use the [REST v2 API](/reference/rest).

---

## Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/inventory.tag

<LegacyBanner />



Inventory API gives you access to your warehouses and warehouse locations, so you can adjust inventory quantities and review inventory changes for products in your catalog. Inventory API allows you to update the local and supplier inventory of each product.

Can work with multiple warehouses, but also organize your warehouse and divide it to as many locations as you want to easily find the products.

Inventory allows you to track stock quantities per SKU and optionally per supplier and supplier product code. That's why there are two types of inventory: local and supplier.

Inventory can also be customer specific, i.e. reserved for a given company and/ or usergroup.

## Inventory item fields

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **id** (integer) | Propeller inventory record unique id. | yes |
| **productId** (integer) | Propeller product unique id. | yes |
| **quantity** (integer) | Available stock quantity. | yes |
| **costPrice** (integer) | Product cost price. | no  <br />Default value is 0.00 |
| **supplier** (string) | Supplier name. For local stock this value is always INTERN and for supplier stock by default this is the product supplier value, but also can create stock for a different suppliers | yes |
| **supplierCode** (string) | Suppliers' unique identifier for the product | `yes` |
| **sku** (string) | Product unique code | yes |
| **dateModified** (date) | Date and time when the stock record is modified. | yes |
| **warehouseId** (integer) | Warehouse unique id. If warehouseId is not specified, it's set to 0 by default. | yes |
| `companyId` (integer) | Company specific (reserved) inventory. Quantity reserved for a given company | no  <br />Defaults to `0` |
| `usergroupId` (integer) | Usergroup specific (reserved) inventory. Quantity reserved for a given usergroup. Will be deprecated in cloud | no  <br />Defaults to `0` |
| **location** (string) | Racks and shelves in the warehouse can be named and keep track of product stock location name. | no |
| **nextDeliveryDate** (date) | Expected date to receive new product stock | `no` |
| **notes** (string) | Inventory record notes. | no |

## Identifiers

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **id** (integer) | Propeller inventory record unique id. | yes |

## Expands

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **inventoryBalance** | With inventoryBalance expanded, detailed view of all inventory records is returned for every product. | no |

## Inventory Errors

This section describes error codes specific for the `Inventory` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `13004` | InventoryExists | 400 | Inventory already exists | Inventory already exists |
| `13005` | InventoryMultipleFound | 400 | Multiple inventories found. Please provide additional filters | Multiple inventory records with such search criteria exist |
| `13006` | InventoryNotFound | 404 | Inventory does not exist | Inventory with such lookup key not found |
| `13007` | InvalidInventoryType | 400 | Invalid inventory type | Not a valid inventory type |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Links

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/links.tag

<LegacyBanner />



Propeller supports different types of resources, such as categories, products, usergroups, users, companies, etc. These resources can be linked to one another to cover different use cases, from enriching products with other similar products, accessories, etc. to indicating an account manager user of a company. These relationship types are predefined and are listed below. The Link API can be used to consult, create, update or delete a link between two resources.

## Link types

| **Type** | **Subtype** | **From resource** | **To resource** | **Use case** |
| --- | --- | --- | --- | --- |
| `accessories` | \* | \* | \* | Typically used for products enrichment |
| `accessoryfor` | \* | \* | \* | Typically used for products enrichment |
| `related` | \* | \* | \* | Typically used for products enrichment |
| `relatedfor` | \* | \* | \* | Typically used for products enrichment |
| `alternatives` | \* | \* | \* | Typically used for products enrichment |
| `options` | \* | \* | \* | Typically used for products enrichment |
| `parts` | \* | \* | \* | Typically used for products enrichment |
| `partfor` | \* | \* | \* | Typically used for products enrichment |
| `account` | manage | user | company | User which is an account manager of a company |
| `account` | manage | contact | company | Contact which is an account manager of a company |

\*any can be used

## Link Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller link id, auto-generated |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `type` | Link type | string |
| `subtype` | Link subtype | string |
| `isDefault` | Indicates whether the `to` resource is the default one of the particular type/ subtype for the `from` resource | boolean |
| `isActive` | Indicates whether the link is active, same as non existing if not | boolean |
| `from` | The resource for which relationships are created | [LinkResource](#link-resource) |
| `to` | The resource to which relationships are created | [LinkResource](#link-resource) |
| `priority` | The order/ priority of the link in relation to other links of the same type, subtype, from and to resource | int |

## Link Resource

A link resource is a JSON object used for identifying resources that need to be linked. It has two properties: to indicate the class of the resource (product, user, category, etc.) and it's id.

```json
{
    "class": "product",
    "id": 56987
}
```
## Link Errors

This section describes error codes specific for the `Link` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `18001` | LinkInvalidClass | 400 | No links defined for class | The link type/ subtype combination is not valid for the from/ to class |
| `18002` | LinkInvalidType | 400 | Invalid link type/ subtype | Invalid link type or subtype. No such link predefined |
| `18003` | LinkNotFound | 404 | Link not found | Link does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/order-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve order details by a specific lookupKey / lookupId combination

| **lookupKeys** |
| --- |
| `id` |
| `sourceId` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"orderitems"},"description":"Optional.  Use `orderitems` to retrieve the orderitems of the order. Use `orderitems.product` to retrive product details for each orderitem."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1600"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Order by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2295"}},"date":{"schema":{"type":"string","example":"Thu, 24 Mar 2022 12:17:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9833f0d7-ea4c-475e-9121-b0558c4083f7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{}},"date":{"type":"string","example":"2022-03-16T15:00:55"},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"id":{"type":"number","example":195},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"julien@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"items":{"type":"array","items":{"type":"object","properties":{"childItems":{"type":"array","items":{},"example":[]},"discountAmount":{"type":"number","example":0},"discountAmountNet":{"type":"number","example":0},"discountAmountTotal":{"type":"number","example":0},"discountAmountTotalNet":{"type":"number","example":0},"discountPercentage":{"type":"number","example":0},"name":{"type":"string","example":"Gallagher MBS400 fence energiser (230V/12V/Solar)"},"notes":{"type":"string","example":""},"price":{"type":"number","example":292.94},"quantity":{"type":"number","example":1},"sku":{"type":"string","example":"390307"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"390307"},"taxCode":{"type":"string","example":"L"},"taxPercentage":{"type":"number","example":11},"type":{"type":"string","example":"product"},"unit":{"type":"number","example":1}}},"example":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","price":292.94,"quantity":1,"sku":"390307","supplier":"INTERN","supplierCode":"390307","taxCode":"L","taxPercentage":11,"type":"product","unit":1}]},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"pickUpLocationId":{"type":"number","example":0},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81903},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"20"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shop":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Propellor Sonar"}}},"shopId":{"type":"number","example":1},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"11":{"type":"number","example":32.2234},"21":{"type":"number","example":0}}},"totalGross":{"type":"number","example":292.94},"totalNet":{"type":"number","example":325.1634}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14718}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Order by Id - 200":{"value":{"data":{"channelId":1,"clientData":{},"date":"2022-03-16T15:00:55","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":195,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"julien@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"items":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","price":292.94,"quantity":1,"sku":"390307","supplier":"INTERN","supplierCode":"390307","taxCode":"L","taxPercentage":11,"type":"product","unit":1}],"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","pickUpLocationId":0,"postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shop":{"id":1,"name":"Propellor Sonar"},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"11":32.2234,"21":0},"totalGross":292.94,"totalNet":325.1634},"type":"dropshipment","userId":14718},"messages":[],"total":1}}}}}},"400":{"description":"Get Order by Id - 400 (invalid lookupKey)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"221"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 01:18:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8bc64fbe-e85a-4361-938d-8b2cbeb867b4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Order by Id - 400 (invalid lookupKey)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Order by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"163"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 15:41:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e1918395-a63c-9e8a-b346-e3deb080aa3d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [162222] not found"},"example":["Order with id [162222] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Get Order by Id - 404":{"value":{"error":{"code":15001,"messages":["Order with id [162222] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Order PDF by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/order-pdf-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order PDF by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupId}/pdf"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Generate a base64 encoded version of the order confirmation pdf based on the Propeller order confirmation template

Reference an order by a specific lookupKey / lookupId combination.

| **lookupKeys** |
| --- |
| `id` |
| `externalId` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupId","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Order PDF by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"21718"}},"date":{"schema":{"type":"string","example":"Thu, 24 Feb 2022 18:56:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"01511fec-9d3a-485f-b8fb-30a746ca0921"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"base64":{"type":"string","example":"JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE1MzQ+PnN0cmVhbQp4nK1Yy3LbNhTd8yvupjPtTAzjTdCryrFbt06dhzXJotMFbdGWHD4UinKarPIp+dRegKBISg7JNk0mdjA65+C+cHGhD8HpPKBgJCNRBPNFcD4PXgcfAkqoCBV8DDj8jp8/BIzCH8Gff1FYBB+AKQr2r5IEQZxBaELCJdxmcLzK7imcFfAaNRRlkYb93+W93fT4FwaGcAXzu4A5NYZ6lEQGjJBEwDwLfnxVFuskTYvyp/mDNe1bPKoIB8PRHFnzVmlRJfmmKuO4Aing5n5YQUbaBsAwRZhxEoyqCJ5fwCzbVEm5iLMRExgnSDBoiWZO4Op8fnH+5sXs6ux6ZG8jiNIYQ01k5KjnR1m8Sk9gld8VP6+bGJA8HbNBExZBGKIvdfwu316egJBMGK3UiBWhIgLJOiRCO/Lp/N0JXL0ghkaYupCwMCSnlI3ISE0UFgTi6ziezq4unQwG6M3s9CWhjDLCKVaM1l6rrqamLjhEXUVbXiJsMvu1oRCjtQ5h/3crEhK1J6OIUf2ygusij0tYbTDU98nmdlkmj0kON6sHWCRwGWdJCY9xDpdFsV7G+SJJocCfJeTbzH6GodUCTwqBi6QCDNiR/wAVr15gQXJhpDYYNQIv1xCnaQIpblHa7XL4vHrIUfBzArP0PsmSPIFudJ/y4QjLrHbibVGUH+O4XKCQtbEqknW82aAygbMENd9v8wq2kMcprnCf9ddlVa1Pjo831mnS1lWyPbaVVmZxtUqOY2/K0WO7AfFmoQGGU3tSskCFEnPZrNNmzRmhEpe8998dahm8C3KbPWj+YcYYJldpQ5hGXW7Qab9K21XEcNUA3WIZ3AVcyhaddYX2wC1wxxWcd7k9qQNCC97xJaVdfk/ugNCCW35ouvye3AGhBe/4SukeP+wFbo/Qgnd8zIjAP7D/u0mIjPBM7RJSr5qEKGrbnI9xs+gkpOF2hPbAHtjl+pDt9u1KHRA8uMv3IWv4PbkDggf3+KHp8ntyBwQP7vJ9jHf8sBe4PYIHd/l7p8JF2rGMPW4O75fpboltVjRZ2a282LcapAgdN8I7m1k7dWRt8Ou0XeN95ALn4X7pItWjNK62Cn7pGfuCbax3At6dRqBZNgJ9Pefe0JUhQgNKGNuObKe83t5URRWn/d4a9W8/Rhjrkk4G0Eq4UmrBMATmPWO+DOq6gaqDZuoZpQMM5yn2Vllf2dfL1Rp7dwW3xabaTPC3pQ77G3ahg97WoWnBw/5GdnzooKe4S7ntYe4KnM3xkvlhgp8tZ9TPFjrBzxY8xc8WLZ/xnp/i0E9pcAqu0fNp1WsZT2VTPGV6Rx6GwLxnyZdBXVe9HTQ/dJP1BhpBIcQzH9VGvyztaHVb5HcrN4sU+YDPruOFOHNEpjcYPhlOag0LFSc86uy0iKtkYAdGTUOTcrR2GHrPe2gujyg/4pTzcdPwxHctwynyJikn2IaFRdVk21o00xOM4sqO8u5BYt8jEC8WZbIZaiuNWcjU422lTiEVhEaHKdzDRvhGEqAN83EaqlnuTluLPUvSFc7cnyY44Kl4noy/O2I3779Nk+19ki6Lu6Gm4NmakbD2/tdkkWTrCi7sS+J9nMdxClyFEzQUavgrgAsJs9P2ITrEjqTdWuNzXo/3ar9VC/7Gk3W/CSvMGJ+cC9FPxm/5Y7G6TSblQnxfMsT/kQ3xPekQyvyrfIj/lBB3jjReouETrXAPq4WbMKLIflsx7SB1wPhwXmxv+5PFQe8A+xLUdZ+5ivtfnOyBWajsLdrinxeLZMggvN466FlW4Bt3yBguu/hX5ephA+vjIfsllnaHgiPGyJUnoy5+7Kq24cHh1l+Q51t8hMdDNeEj1FKi0ESUR4oxnFaGikLRPnGw8mxcWygb1OWuglr030Pu+ufiJCtctlro0EQl6iuqa/PI6Cipnm6JK4Jplsj6yuugxTOmBgh+cpxmiHs8TDOkeTxMD4l/2O/641DfqB+Y+JALxei4VbcNKZEi+xdwllTLYjGUVxaRmqqj0UHW7yP07nzHn9zrZ+o2yDS9XexX36+DfwDszggXCmVuZHN0cmVhbQplbmRvYmoKMyAwIG9iago8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtUm9tYW4vRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjUgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmRvYmoKNiAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0hlaWdodCAxNDYvRmlsdGVyL0RDVERlY29kZS9UeXBlL1hPYmplY3QvV2lkdGggNDAwL0JpdHNQZXJDb21wb25lbnQgOC9MZW5ndGggMTMzOTM+PnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFP/AABEIAJIBkAMBIgACEQEDEQH/xAAeAAEAAgICAwEAAAAAAAAAAAAACAkHCgMGAgQFAf/EAFwQAAEDAgMEBQQKDQgHBgcAAAECAwQABQYHEQgJEiETMUFRYRQiOHEyQlJ0dXaBs7S1FRYZIzc5YoKFkaGy0zM2V1iUlaKxFyRHcnODxBhDY4SSpSZTVpPU1fD/xAAcAQEAAgMBAQEAAAAAAAAAAAAABQYDBAcCAQj/xAA1EQACAgEBBQUHAwMFAAAAAAAAAQIDBBEFEiExQQYTUWFxMoGRobHB0RQi4SMz8DRDUmKS/9oADAMBAAIRAxEAPwC1OlKUApSukZr5t4ayXwlIxFieemJDb81plPnPSXOxttHtlH9QHMkAE18k1Fat8DJXXO2arrWrfJI7vUfM59uLKnJVx6FMvZxBe29UqtdjCZDiFDsWvUIQdesFXF4GoE7T+3LjjN6P9ibU89hLDUkr1gwnCHpDPsR0rw01CvPBQAE+aBz6zE/hqJsz1/t/Eu+J2ZkuOZLTyX3f4+JNjMjep4/vy3WMHWG14UiE6JfkgzpXgdVcLY79Cg+vvjvizapzfxstxV1zFxApLns2YkxURk+HRs8KdPkrF/DThqPlfZPnItVOzcWhf0619X8T2bnfLpe1E3G4zJ5JCiZTynCSBpr5xPPTlXrxJUmA4XIz7sZZHCVtKKSR3cuzlX5w04aw7xvKCS0O9Ydz+zOwksKtGYGJIIB16JF0eLZ9aCrhPWesVnXL7eZ5w4TdQi9vWzGMMHzk3CIGXgPyXGeAA+KkqqKHDThrLG6cfZkaluBjXrSytP3FtOUO8xyzx+6zCxO1KwHcnNAFTj08MqPZ06QOH1rSkeNS0ttziXmAzNt8pmbCfTxtSI7gcbcSe1KhyI8RWvFw1lPJHaVx/s/3RL+Fr04m3lXE/Z5ersN8a89W/anl7NBCuzXTUVv1ZzXCxFYy+zcJJyxZaPwfL4818y9alR12ZNtHB+0ZHTb06Yexg2gl2ySnQelA5lbC+XSJ05kaBQ56jTzjIqpaE4zW9F8Ci3UW403XbHRoUpSvZgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSldNzVzOsuT2Bbpim/PdHBhI1S0kjjfcPsGkDtUo8vDmTyBNfG1Fas9whO2argtW+CR1/PzP/Dmz7g9d3vbvTzn+JFvtjR++zHQB5o9ykagqUeQHeSAaks3s5cVZ7YwXesSTFSXieCLBZ16CKg6eY0js6hz5lR6ya485M379ndjqdia/PffXjwx4iVEtRGQfNab16gNeZ7SST1mumMqMduRJAJ6BorBSrhKVE8KVD1KUk/JVSysuWTLdj7J3HYuxKtkU97YtbWuL8PJfd9T4N7eRKuTpaIU0jRttSRoFJSNOLTs104vWTXocFc3BTgrxqbji3xZw8FOCubgpwU1Pm4cPBTgrm4KcFNRuHDwU4K5uCnBTUbhw8FOCubgpwU1G4edunS7PPjzoEl2FNjOB1mQwsocaWDqFJUOYII11FWk7E23G3m2IeBscOoj4zQ3wxLidEt3QJHUR7V7TmQOStCRoeVVZ8FcsSQ/b5TMmM85GksLS4080spWhYOoUkjqI011HVWem+VMtYkZtDZlW0KtyfBrk/D/PA2GKVGTYh2pE7QGBFWy9PITjayISiaOSfLGupMlI8TyWByCu4KAqTdWaE1ZFSjyOOZOPZiWyptWjQpSlZDWIabxHbZxVsdfaB9rNjs96+2L7IeUfZYOnovJ/JuHg6Naevp1a669Q8aw+dt/bNA57M5+SzXD+JXVt+d/sT/Tf/QVapQEGdmDeawc1cy0ZZ5mYQkZZ46edEaM1JUsMvyDpowtLiUrZdVr5qVahXVxBRSDmbbf2h71svZEysc2G2wLrcGZ8aII9x4+iKXFEE+YpJ1GnfUI99Vhq34bxXlNji18FuxQ/5ZHclM+a66mOphxleve2pxfPn7NPcKznvTbk9edhBm4SWizJlzbW+62faKV5xHyE6UBibCW8K2sse4ehX/Duz5FvVlmpK40+FbJ7rLoCiklKg7oRqkj5K79kPvTzfMzomXOc+ApGWWJJLyIyJbnStsoeXpwIeZdSHGQokAL1UPOGug1VWb9276EuVvvKR9LfqKO+8w5ak2DK/EIZbbv3lUuCHxoHHI/ChfCe1QSvmOwFxXuqAs7lSmYMZ2RIdQxHaSVuOuKCUoSBqSSeoADXWq5McbzXMTNjMa4YN2Z8tRjNEEqS7e7gw68lwcXD0qW0LbSy3r7Fbq/O1GqU9VZH22s2rxhvdtN3VchbN9xPZbVbn3upWsltsyQQefnNh5PeOLXsr726zytt+XmyJhi5sxUN3bE63rtPfGhU5q6tDI17g0hHLsJV1EmgMEI3jufWz3iS2RdorJ9u3YenL6NN0s7K2XAeslKi64y6pI/7sKQdOZPfY1g/Ftnx9ha1Yjw/OaullukdEuJMZJ4XWljUHvB59R0IOoOhFYx2x8soGbmzLmJh+dHRId+w8ibDKhzblMNqdZUD2HjQAe8FQ7TUZtzJmDLxJs6YgwzLdU8nDl7WmJxHUNx320ucA/5oeV+fQHq7Ue8IzWym2o7hlHgDANnxfIS1HXDZWzIdlyFuR0vKSEtuAHTVXUOoV1uTt47X1mYXOuezQ79j2Bxv9FaLgFBA6zqFK0GnPXQ6dddax9+O1w5/5b6pVVqtARe2NNvLCW13Dm29mC5hfGlub6aXYpD4d42tQkvMuaJ40BSgCCAUkjUaEE9I3hm3NizY/vOCYmGrDZry3fWJTr6rqHiWy0poAJ6NaevpD169lRnxxa4uUW+Sw6cKNpit3mdFdmRImgSlUuMUSdU/lcSnTr2q1A6q5t+L/OrKT3lcv349AZA/7b22d/Vn/wDZ7h/ErLmy3tL7RmaObDFizLyX+0jC64jzy7t9jpbPC6keYjidWU+cezrqZ1KAhPtX7c2LMgtqzLvK2z2GzXC0YlYtzsiZODvTtGROdjq4OFYToEtgjUHmTrqOVTYqpXeTfjI8i/edi+uJVW1UAqE+z3tzYszf2z8wcnLlYbNCseHJF2Zjz4od8pdESWGEcfEsp1IOp0A59WlTYqpXYe/GvZ3+/MS/WaaAtqr0LzeIOHbRNutzlswLbCZXIkypCwhtltCeJS1KPUAATrXv1Cfe6Zhy8D7I0m3QnlMuYmvEa0OlBAV0PC5IWPUfJwk6ditO2gMUXzeW5u56Y3uVh2asqhiK1wFcLl5u8Zx1S06nRwpDjbccK0PCHFKJA10B1A/bJvK838isa22x7SuVCcPWuerhbvNojuNFtOvNwArcbfCe0NqSoDnoToDJrd35XQMrNkTL1qJGbal3y3t36a+kDifclJDqVK9Tam0DuCB261+7xDLKBmhshZhsy46HpNkgLv0J5SdVMOxUl1SknsJbDqD4LVQEhLJeoGJLPBu1rlsz7bNZRJjSo6gpt5taQpK0ntBBB1quPN7eSZy4d2mMW5UYBy2s2LpNqmuR4jLceU9LfQhvjUopQ4AdBqeQHIVlTdFZgy8bbIsa3zHVPLw1eZVnZU4dVdFwtyED1DygpGvUE6dQFRsyb/HR4p9+3T6CqgO4XreRbS2WEcXvMLZ0XAwy0QJEhMOdCSjmNNX19IhHcOJPM1NrZj2nMI7VeXSMU4VW7HUy55PcLXK0EiC/prwK05KBHNKhyI7iCBlS52yJe7bKt0+M1Mgy2lsPx30hSHW1ApUlQPWCCQRVUe5+eVYto7OTDdrcUvDqYalI87jBLMstsniHIngcXz7aAtopSlAKql289oJWbGZa8NWqTxYWw44phvoz5smV1Ou+IHNCevkFEezqd+15m+rJjI693aI90F5mgW22kdYfcB84eKEBa/Wkd9U3Kc1JOupNQO0r2kqo+86Z2P2apyln2Llwj69X9vifteE1bX2McR5wfU6jh06igBXF+0pr8JJr7+HsFX3MR+1WLDVolXq7vyHyiPFRxK04WvOJ9qkdqlaADmSKgoJt8DpeRNRrbk9EdJ4PCvu4PwBiLMG6i24asc++zjzLMCOp0pHerQeaPE6CrA8iN2TbLc3HuuaM83OXyX9gbY6UR0fkuvDRSz4I4QNPZKFTZwpgyxYFtDdrw9Z4VltyPYxoLCWUa9+iRzPieZqapwJz4zehzvO7TY9DcMZb78eS/krCy/3Y+ZuJ0IfxFMtWD46utp9zyqSB38Dfmf4xWfsLbq3AVvbQq/4qv16eT1iGlqG0r80pcV/iqblKk4YVMOmpT7+0G0LnwnuryWnz5/MjVbd3fkVBRo9hSTcTp7KTdZQP+BxIr3vufuQf/wBBf+8T/wCPUh6Vn7ir/ivgRr2lmt699L/0/wAkWLzu2slbohYjW27Wgq10VCua1FPq6UL/AG61ijGG6htTqFrwrjuZFWOaGLxDQ8D4Fxso09fCan9SscsWmXOJs1bZ2hU9Y3N+vH6lOeZOwHnBl0h2Qiwt4ogNgkybA75QoAf+EQlwnTuSR41HmVBegyXY8lhyO+2rhcadSUqQodhB6j662Eqxpmzs84AzthLZxXh6NMlFPC3cWk9FMa5cuF1PnaD3JJT3g1pWbPXOt/EsmJ2qnFqOXDVeK4fL+UUacHhTg8Kk7tcbGy9nAwLrbb8i74ducgxoyJaejlNOBJWEKI8xeqUnmOEk8uHq1jQpsoUUqSUqSdCDyIPdULZCVUt2a4nQcXIpzKldRLVM7dk5mld8lcx7Ni6zHWTAd1cYKtEyWTycaV4KSSOrkdD1gVeHgjGNszBwjaMSWd/ym2XOOiSw528Kh1HuIOoI7CCKoO4PCrHN13m+q44fv+XE57Vy2qNztqVHn0C1APIA7krKVet01I4F27Pu3yZU+0+z1bQsuC/dDn5r+H9yelKUqwnLCqvfnf7E/wBN/wDQV2r7rtjj+rDiD+93/wD9fXVd+d/sT/Tf/QVapQFR8LJ/PDeT59YcxZmdhCRl/ljY+EJiS2HGAtjjC1tMpd0W646QEqd0CQEj3ISZM73VsN7GlwSkBKReYAAA6vPVU16hVvePQ3uXwzB/fVQEVNmHbTz/AMrsgcKYdwps93fF2GLbHdTFvzFrnuNSUF5xalBbbZQQFKUnUH2vrr4OU9kx/vZ8+W75jy62u0YIwh0XlNot6yhTcd1ZV0UdslSit0taLeUdAANNdEoqwndu+hLlb7ykfS36gu+79z13mZWSbflzjRziVz4WGoUxzme4CPIST3htH5fMCR++IYbjbIVvZZbS003iSElCEJASkBmRoAOweFZu2A/Q3yn+Bk/vrrqu82y3mZkbHONG7e0p+dZize22kp4iUMOAvHw0ZU6rl7nTtNfD3VeblszG2TcP2NqU2u+YTW7a58biHGhJcW4wvh6+FTakgHtUhY7KAk3mz+CzGXwNN+YXVdW46/mtm379tvzcippbaGacDJ/ZizDv06SiO87aX7fBSo6KclvtqaZSkdp4lcR06kpUeoGo37mrLmZhbZxvmJprKmRia9Lciaj+UjsIDQWP+Z0w/NoCNG13mlMyW3qSsawMOv4tmWlqG63ZozpbcklVuCOEKCFkaBfFySer5azNJ3tWY05hbFs2Zb4i4ODhYU5cJL6Qvs1bTCSVDwCgfGus4+/Ha4c/8t9Uqq1WgK09iTZWzTzC2kbhtIZ425yx3Za3H7daJbJafU8proUqLKiVNNNNeahC/O1CT7XVXQd+L/OrKT3lcv349W1VUrvxf51ZSe8rl+/HoDIH/ZQ29f6wOH/71l//AINSc2O8rs88sbdidrOzHkDHMqY6wq2OQZTr4jISF9KD0jLWnEVI6ters7ZHUoCpXeTfjI8i/edi+uJVW1VUrvJvxkeRfvOxfXEqraqAVUrsPfjXs7/fmJfrNNW1VUrsPfjXs7/fmJfrNNAW1VXVvtPwB4F+Mw+iv1YrUKt7flxLx5sjS7hBaU89he7Rry4htPEos8Lkdz5EiRxnuCNeygM/7Jvos5N/EyzfQWabWXos5yfEy8/QXqxzu5c3LbmvslYFTElNuXHDsFuwz4wUCthcdPRt8QHUFNJbUD2g+Brk3i+advyu2RMfqlSUNTb7BXYYTJVop9ySOjWlPfo0XFHwSaAwFuS/wB46+Mx+isVFfG2ZWL8o96Fj3E2BsHyceYjjXKYhixxGHnnHkrjcCyEtArPCklXIdnOp07pHLmZgPZEhzpzKmXMTXeTemkrTooMlLbDZ9ShH4x3hYPbUacm/x0eKfft0+gqoD4+0NvMtoiFhb7W7nlevKGZfW3GGbnc4UuNJU3oErMcyAhKSONOq9Dw6jqOhEyt3fsaK2T8ubjLvcyLcsZ4lLT852CvpGIzKAromG1+29mpSlDQEkAahAUeHeg5AjO3ZjulxgRumxDg8qvcMpT562Up0lNjwLWq9BzKmkCvDdebQf+m/Zpt9ruEvp8S4OUmzTeNeq3GAnWK6fAtjg1PMqZWaAmDSlKArU3nuYi7vmNh3BzDmsWzwjMfSD/3755AjtIbQgj/iGoU6isp7VWK14w2iswLipZcCbs7EQrvQx94T8mjYrFBOtUzJl3l0peZ+hNk0LFwKal4LX1fF/NnmV1ZTuto7H+ivFsjomxJN64FO6DjKegbITr3ak6D11WjxVYbup72l20ZiWk6BTL8KUnvPGl1J/VwJ/XWxgNLIXvIntOnLZc9OjX1RPqlKVaziIpSlAKUpQClKUApSlAQg3sjbRyKwq4V6PJxI2lLfekxpHEfk0T+uqxLfegUpYmkqbACUPAaqb06tfdJ05adY5adWhsm3tlzS3lngW3cuN+7uyB6m2Sk/OiqwKgMzR2vU6h2fbhhRkn1f1O1raUjhOoUhQ4krTzCh3j/+8DWXNkrMBeWe0Lgu7FzgivTU2+Xz83oX/vSie8JKgv1pFYLtF3ML7w8C5EWdSkdaD7tPjy5jqI5dYBHYE8bDiHGnCCNFtuoJHqUP86i+NUlJF00hm0zpn1TT960NgClddy9xMnGmAsNYgT1XW2xpw5afyjSV9X51diq5J6rVH59lFwk4y5oh9vA9iK+bZBwGLNiW34d+1zy/pfLmVudN5R5Ppw8PVp0B117xUwaUr6eRWBttPZ1uO1HkfJwLarvFskt6dHliXMbUtADaiSNE89TrWeaUBinZcyemZBZC4RwBcLgxdZlkYcZcmRkFLbpU845qArmPZ6Vi3b02Kk7YeE8OMW66xbBiSxy1rYuEtpTiFRnEaOtEJ581JaUD2cJGnOpUUoDouTmEr/hLKTDeGcY3ONiG+W6AmBMuDKD0csIHAlZCuZKkBPFr1niqEGY262xTgrMaZjTZxzLcy5kzCortEl59lloFXEW0PNBRUzrp97WhQGg5nkBYzSgKz4G7EzfzmxVbZ+0LnOcSWiAsKTbLRJkSStPalCnUNoYKgOaktqJ/aLGMK4VtWCMOWzD9igNWyzWyOiJEhsDRDTSBolI+QdZ5nrNfYpQEPsR7EV8ve3rbM/kYlgNWeJ0XFZ1Mr8oVwQzH5K9j1nX1VMGvQu16t9giKl3OfGt0UEJL8t5LSAfFSiBXVbfnnlvdpSI0HMDC02Sv2LMe9RlrPqAXqaA7zUM9v7YUvu2Jd8GTLNie3YeTYWJTTiZzDjhd6VTZBHD1adGevvqZKFpcQFJIUk8wQddRXnQFav3PXan/AK12IP77un8asp7M+yBnvlLm9asS45z8u2PMORmn0P2OVc577byltKShRS64UHhUQrmOzlU16UBBfbe3fmLdqHO3D2PsNY3g4UctFnj29rpW3enQ81JfeDqFoI4dOmToQdQU61j37nrtT/1rsQf33dP41WVUoCL+x1s45sZE3LFD+ZOblxzNYuTUdEJqdOlyREUgrK1Dp1q04uJI5aa8POo24x3XWaz+emOcxMFZxs4LlYivE+4NuWsyoslpmTIU90SnGlJJ606gHQlNWZUoCtX7nrtT/wBa7EH993T+NUy9nvKLEeXuR0XBOZGKHMyLqrypufc7k67J8rZdWr72svFSlJCFcGhJGnLqrL9KArZxTuucf5WY5uGI9m/Nh3BDE4+fablJkMpbTqSGy80lfTIBJ4Q42SO1SjzrxwzuvMx81sc22/7R2bS8aQ7erVNotsqQ+l1GupbDrqW+hQrQcQbb1PPQg+dVlFKA9K0WqHYbVDtlujNQYENlEeNGYSEoabQkJQhI7AAAAO6ogYI2Fb7hTbru+fTuJrc/aZr8t1NoQwsPp6aOWhqr2PInWpmUoDieaRIaW24hLjaxwqQoahQPWCO2oVbK2wTiTZW2iMTYssWLre/l/ehIYOHyy4H22CsuRhxexK2jonXlqkq79Km1SgFKUoCgjEd1N6xBc7iTqZcp1/UjTXiUVa/tr5nFXJLYXClPMO/yjS1Nq0Oo1HL/ADFeuV91UbQ/SKaSSXI8ye+pbbszGaLFn/Jsjrmjd9tTzLSdet5opeH+BD1REJ1rtuUWPXcr8zsMYqZClfYqe1JcQnrW0D98T+cgqT8tZ6Z93ZGXgRu0aP1WJZT1knp69PmXx0r1YM6Pc4UeZFdRIiyG0utOoOqVoUNQR4EGvaq5HABSlKAUpSgFKUoBSlKArD3s+Kkz8xcD4bS4FG22x6cpI9qZDgTz+SMDp2Dn21AsprOW2XmGjM/aRxpdmHA5BjyvsdFUk6gtxx0XED2hSkqV+dWEiKrN09+yTR2LZ2O6MOqD56fXievX2rJdw2kQ5J+8k/enD1tK7v8AdPd2HmO0H5RTXGRpWFpSWjJGMnXJSjzL0NkSU7M2a8v1PpWhxu3BgpcGhAbWpA/YkfJWYqwRsONPMbKWXKX+azAWoaq180vOFP8AhIrO9Wer+3FeSOM5r1yrX/2f1KgN95+FPLX4GkfP1WtVlO+8/Cnlr8DSPn6rWrKaRtUUpSgFRU3o/oK5mfoz6ziVKuoqb0f0FczP0Z9ZxKAoCq9PdD+hvbfhmd++mqLKvT3Q/ob234ZnfvpoCatV47wXeVuZH3OXlzlg5Hl42aHDc706hLrNrJAIabSdUuPaHU8QKUdRBVqEyu2s87Rs8bPuMsdI4FXCBE6O3tucwuW6oNM6jtAWtKiPcpPVWuFc7nLvdylXC4SXZk6W6t9+Q8oqW64olSlKJ6ySSSaA+1jzMjFWaN9cvOL8Q3LEd0XrrJuMhTygDz4U8R81PgNAOwV1qp5bujd72/aagT8dY9emRsExJBhw4MNfRu3J5IBcJX1paRqkap5qUSARwHWwPFO632csR2BdtjYIdw+/wcLVxtl0k+UNeP31xaVH/fSqgKcchNrzNTZwujD+DsUym7ahQU7Y5qy/b3x2gsqOiSfdI4VflCrxtkDa4wztcZd/Zu1JFsxBA4GbzZFr4lxHSOSkn27S9FFKtOwg6EEVRntWbON42Wc5Lrge6yPL46EJl265BHAJsRevA5w6nhOqVJUOeikK0JGhPYNhjP6Vs7bSGFb+ZSo9hnSE2u9NlWiFw3lBKlqH/hq4XR4t6dpoDYnqgHej+nVmZ+jPqyJV/wBVAO9H9OrMz9GfVkSgMf7FHpb5Q/GaD86mtj6tcHYo9LfKH4zQfnU1sfUBH/b89DfNj4GV++itdetijb89DfNj4GV++itdegLqdyp6LOKfjnK+gwa+rvkvRHh/GaF8zIr5W5U9FnFPxzlfQYNfV3yXojw/jNC+ZkUBSDWwnu3fQlyt95SPpb9a9lbCe7d9CXK33lI+lv0BGrfefgsy0+GZPzAqoGrft95+CzLT4Zk/MCqgaA/QSk6g6HwrKWWm1Hm1k/Nak4TzBvtrDZ4hFMtT0VR/KYc4m1fKk1aJkXutsjMxMisvcT3WHfRd77hu33KW7HuhSnpnorbiylPCQBxKOg5gVHjbY3V/+gvBE7H2W94n37DltT0tztd14FS4rXa+hxCUhxCdfOHCFJHPVQB0AkvsN70G357XaDgTMhiHh7G0jRuDcmDwQ7mvsb4T/JPHsGpSo8hoSEmwGtVyPIcivtvMuKadbUFoWg6KSRzBB7DWwTu9tpB/aU2c7Td7tI6fFNmcNovCyfOdebSCh4/8RtSFE6AcXGB1UBV7nbYFYTzjxvZ1JKBCvUxlA5c0B5fCfURoeyuklVSe3jWBF4P2krjcUo4YmIYbFxbI6gsJ6JweviaKvz6i6TVOuhuWSj5nfcHIWRi12rql9DyKq/Cda8CvurxJNY9Da3i3Hd4ZzozLyNj2CXI6S94UKbe6lR85UY6mOr1cILf/ACvGpU1SPsoZ9PbPmcNtvzilqsUr/UbuwjnxxlkarA7VIUErHaeEp1Gpq623T412gx5sN9uVEktpeZfaVxIcQoapUk9oIIOtWfDt7yvR80cd2/g/pMtziv2z4r16r4nt0pSt4rQpSlAKUpQCsTbUObjeSWSOJcTpdDdySwYttTy1VLd81sgdvCSVke5Qqss1VbvJs+hmBmPHwJapAcsmGVEylNnUOzzyX6w2PM8FFzr5Vq5Nvc1t9ehM7IwXn5ca2v2ri/RfnkQvc1WoqUdVE6knmSa4ymvYKa8CnWqxqdkcT1imvApr2Cmu25PYBdzPzVwphVtKiLtcWYzpT1oaKvvq/wA1AUr5K9ri9DWsahFzlyXEuy2dsNqwjkTl9Z3EdG9FsUNLyNNNHSykuf4iqsjV4IQlptKEJCUJGgSBoAK86tqWiSOHTk5zc31epUBvvPwp5a/A0j5+q1qsp33n4U8tfgaR8/Va1fTwbVFKUoBUVN6P6CuZn6M+s4lSrqKm9H9BXMz9GfWcSgKAqvT3Q/ob234Znfvpqiyr090P6G9t+GZ376aA6Jvq8UPW7IHBtjbUUN3PEIfdI9slmO5on1cTiT+aPlpnq2jfi/zWyk9+3L5uPVS9AbF+wnhCPgnZAyngRkJQmRYY9zVw9q5SfKVH16ums81inZN9FnJv4mWb6CzWVqAqy34GEWDByqxQhtKZSXZ1tec7VoIacbHqBDv/AKjVUlW/b7z8FmWnwzJ+YFVA0Bs0bP2KXccZEZc4hkudLJuuHLdNeXrqS45GbUvXx4iapB3o/p1Zmfoz6siVcnsU+iPlB8WYPzKaps3o/p1Zmfoz6siUBj/Yo9LfKH4zQfnU1sfVrg7FHpb5Q/GaD86mtj6gI/7fnob5sfAyv30Vrr1sUbfnob5sfAyv30Vrr0BdTuVPRZxT8c5X0GDX1d8l6I8P4zQvmZFfK3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrIOKMOwsX4Zu9iuLfS2+6RHYUls+2bcQULH6lGsfbJvos5N/EyzfQWaytQGrBcIK7bPkxHSlTjDqmlFPUSkkHTw5VZbuQ8XyI+O8zMLFalRZdti3MI9qlbTqmyfAkPj18I7qryzSaQzmbi5ptCW20XeWlCEjQJAeXoB3DSprblT0psU/EyV9Og0BODeaZTKxjk/BxhCYLlwwvI4nikecYjxCXPXwrDSvAcRqq0nvrYIxDYYOKbDcbNdI6ZduuEdyLJYX1ONrSUqSfWCaozz5yhuWReaV7wjcQtYiO8USSpOgkxlc2nB6xyOnUoKHZUFn1aSVi6nSuzGcp0yxJPjHivR/z9ToRVXiVV414lVRWhdnI8tTVh+7j2r0BuNlLiuYEqB/+H5jyuvXmYhPf1lHyp9yKrsKq/WZDkZ5DzTi2nW1BSHEEhSVA8iD2HXtFbFNjplvRIvPxK8+h02e5+D8TYjpUMNiHbfYzfixcEY3lNxsbsI4Ys1eiUXVAH6g8ANSn23WO0CZ9WauyNsd6Jx7KxbcO11WrRr5+aFKUrIagpSsc54524fyFwJKxLf3Cvh+9xILagHZjx9i2jX9ZPUBqefVXmUlFb0uRkrrndNV1rWT5Ix/tl7SkfZ+y3dRAeQrGN3Qpi1R+stctFyFDuQDy161cI0I4tKc5Lzsp9x59xbzziitbjiipSlE8yT2nt1Nd3zezUv2dWO7hirEMjpZkk8LbIJ6OMyD5jTY7Ep1+Ukk6kknpJGtVbJyHfPVclyO1bI2VHZmPuvjOXN/b3HrlOlcZTXslNcak1rJkw4nrkVODda5SLvmY16zAlM/6jYo5hQ3D2ynk6K0/3WuIH/iioYWiyzcQ3eFardHXMuM15EePHbGqnXVq4UpHiSQKvA2c8nIuRGUNiwkz0bkthvpp8hvqflL5ur8Rr5o/JSmpLCq7yzefJFP7R5axsXuU/wB0+Hu6/gyfSlKsRykqA33n4U8tfgaR8/Va1WU77z8KeWvwNI+fqtagNqilKUAqKm9H9BXMz9GfWcSpV1FTej+grmZ+jPrOJQFAVXp7of0N7b8Mzv301RZV6e6H9De2/DM799NAYZ34UZxWDcp5ARqyifcG1K7lKbYIH+FX6qqSq7DfLYHexDsw2m/x2uNWH7+w8+vT2DDzbjJP/wBxTAqk+gNlLZN9FnJv4mWb6CzWVqjPu48xouZOx5l88w8lyTZon2Clt8WqmXIx6NKT3atBpYHctNSYoCtXfefgsy0+GZPzAqoGrPN9vmPEn4qy2wNGeC5VtjSrrNbSrUJ6ZTbbIPcdGXT6lDv51kR47kp9tlltTrrighCEDVSieQAHaaA2Odi1tTWyVlClSSlX2sQFaHuLKSD+o61TXvR/TqzM/Rn1ZEq9HKTCCsvsqcGYWWAFWOywrYQDxAFlhDfX2+x66o13p0N2Nty5huOJ0RIbtrrZ70/Y6Mj/ADQoUBjjYo9LfKH4zQfnU1sfVrd7GsxmDtYZQvPuBpsYot6eI9QKn0JH7SBWyJQEf9vz0N82PgZX76K1162F94rd27JsW5pyHdOFy3tRhqrTznZDTQ/ascv8q16KAup3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMivS3L8B2HspX11waIlYtlvNnvSIsRH+aFV7u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrK1Yp2TfRZyb+Jlm+gs12TOHMaDlFlZivGdycQ3DsduemnjOnGpKTwIHipXCkDtKhQGtbmPMRcsw8US2goNSLpKdSFciAp5RAPjzqb+5VZcVtP4rdCSWk4OkoK+wEzYRA/Yf1VAB11ch1bjq1OOLPEpajqST1kmrTNyFl490+ZuOnmuGPwxrLFd09mrm8+nw0Hk58eLwoC1iou7dOy7/p8wAm72KOlWNrE2pcMDQGazrquOT39aka+21HLjJqUVKxzgrIuMjZxsizFtjdU+KNd19pyM8408hTTqFFK21p0UlQPMEdhrj1FWW7eGw6vFqp+ZOXsLivYBeu9kjp5zABzfZA63fdI9v1jztQqs5WoJB1BHLSq1bTKmW7I69g59WfUrK+fVeDPIqrx4q8eKvEqrFob28czEl2I+2+w6tl9pQWhxtRSpCgdQQew689RViWyfvJG+hh4UzcklK06NRcU8OoV3CUB1Hs6QdfLiA5qNcpVXjxVsVWSqlrEjczDpzq9y1ej6r0Nie33GLdoLEyFJamQ5CA40+wsLbcSeYUlQ5EEdor26o82dtqnMvIi4JjYXnG52Qq437FcNXYhB5FQ5joTqR5ySka6cWoGlSxzF3nFzueEI0XCOG0WTEL7X+tzJbyZLcRfaGRwgOH8pQ0HuVddSv66pR1nwZSH2azZWqFC3ovry09f41JZbQO0xhLZ7sJkXiR5be32yYVkjKHTvnmOI+4RqPZHuOmp5VUtnPnPibPPGL2IMSy+kcOqY0NokMRG9fYNp7B3nrJ5kk113EeILni69S7veZ79zuktZcflSVla1nxJ8OWnUByHKvlEd9QWTmSyHpyj4HS9kbBp2VHe9qx839l4fVnrlNcZTXslNeBTWnqT7iespOlcZTXslNS92K9il7NmZFxrjOMuPgtlfHFhLHCq6KB/WGQRzPtuodpGequV0t2BFZuVTg0u656JfPyRkjdybLS4QazZxPE4XXEKTYIjydCEEaKlEeI1SjXsKlac0mrBa4WGG4rKGWUJbaQkJShA0SkDqAHdXNVtpqjTBQicOz82zaF7vs68l4LwFKUrMR5UBvvPwp5a/A0j5+q1qt93rOy7mjn9mDga4YAwjJxJDt9reYkusPsthtZd4gD0i09ndUFvub20j/RbcP7bE/jUBKr7uLfP6JLf/AH4v+BT7uLfP6JLf/fi/4FRV+5vbSP8ARbcP7bE/jU+5vbSP9Ftw/tsT+NQFgmynvUrptIZ+YWy6kZdw7EzevKuKe1dVvKa6GK8+PMLSddei4esdevhWZd6P6CuZn6M+s4lQb2AtifOzKLa2wJizF+AZllw9b/L/ACmc7JjrS30kCQ0jkhwk6rWkch21YTt+5b4kzc2SMd4TwjanL1iG4eQeSwWlpQp3o58d1fNZAGiEKPMjqoDXdq9PdD+hvbfhmd++mqwPub20j/RbcP7bE/jVbbu2spcW5KbMkHDONbK7Yb43dJb6obziFqCFqBSrVClDnp30BnPOXK+2Z05V4owPeOUC+QXIinAniLSyNW3QPdIWErHikVrb5p5Z3/JzMG+YOxPDVBvVokKjvtkHhXp7FxBPskLSQpJ7UkHtrZ8qM+2LsLYM2ubM1ImOHD+NILJbgYgjNBauHrDT6OXSt6nUDUFJJ4SNSCBTzsf7bGMNkDEM120Rmr/hm5FKrhYJbpbbdUnkHG1gHo3NOXFoQR1pOg0mrijfe2/7X3BhzK6SL4tGiDdLmkxmld54EcTg8PN17xUTc092Pn/lnPdQzg9WL7cFEN3DDbokpc/5XJ1Pyo08TWIbpsw5wWOzz7rdMq8Z2u2QGVSJUydYJTDTLafZKUpbYAA6yewc+ygOvZrZo4izozAvWM8VTjcL5dXumfd00SkABKUIT7VCUhKUjsAFST3ZWzLMz42g7Xfp0NasH4Pfauk99SfMdkJPFGYHeVLSFEe4QrXTUaw+q3zdV7Y2X72C7RkvOtUDBeKGVkwpDOoYvrqvZLUpRJEk6AEKOigEhGgAQALLKqS30uRsuHivCebECKpdumxhY7m6gcmn2ypbC1f76FLTr1DoR3jW22uu4/wDYM0sG3bCuKLY1drDdGTHlRHtdFpPPUEc0qBAIUCCCAQQQKA1grfPk2qdHmxHlxpcdxLzLzZ4VNrSQUqB7CDodatHyx32Rg4XhxMeZfP3K+MNBD1ys01DbcpQ9uWVI+9k9ZAURr1ADkMf7RG55zAwjd5U/KiSxjXD61FTVtmSG41xjp9ySspbdA90Ckn3PfFK7bG2e1klGPIygxq4sdsOxyJKP/U0hSf20BmjbZ3j192ssPRMJW3D6cI4PZkJlvx1SzIkzXU68HSKCUpShPFrwAHzgCVHQAQ7ixXp0pqPHaW/IdUG22mklSlqJ0AAHWSeWgrP+B937tB49lNswcrr3bkq63r42LchA7z05QfkAJ8DVk+xJuurVkHfIWN8w5kPFONI33yDBjIKoNtc/wDmAqALro7FEAJPMAkBQAkVsWZKv5AbM+CcHz2w3eGYqpdyA6xKfWp1xBPaUFfBr3IFYG3yXojw/jNC+ZkVOqoj7zjJ3GWeOzjGw5gaxvYhvSb9GlmIy42hQaS28FK1WpI5FSe3toCg+thPdu+hLlb7ykfS36qA+5vbSP8ARbcP7bE/jVc9sPYBxBlbsr4Awrim2uWe/wBtivNyoTi0qU0TJdWBqkkHzVJPInroCJe+8/BZlp8MyfmBVQNXfb1nILH+fuX2BbfgDDb+JJlvubz8lph5pvo0Ka4QT0ik9vdVav3N7aR/otuH9tifxqAkDllvib1llldhPB0fLKBOGH7NEtDU127rT0vQMoaDikBrlrwa6BXhr21H/aj2+8ztqqG3aL89DsWFWnQ8mx2ZCkNOrHsVPKUpSnCOwEhIPMJB51+p3bm0itQSMrZ4JPWqdDA+erKWWe58zwxdMa+2j7C4Eg8Q6VcyaiZICe9DccrSo+CnE+ugIbYFwRfMysXWrC+Grc9db7dHxHiQ2BqpxZ/YABqSToAASdADWxRsoZAQtmXIvDmBoy25E2M2ZNzmNg6SZjminVjt4ddEp158KE611XZR2HMvdky2rdsbLl6xXJa6KZiO4IHTrTrqUNJHJpH5KdSdBxKVoNJF0ApSlAKhptb7vu0ZxuzMV4HMewY0Xq5IjL82JcVdpVp/Jun3Y5KPshzKhMulY51xsjuyRtY2VbiWKyl6P/OZr343wBiPLfEj9gxPZpdmvDJ0VFkt6KI7FJPUtJ7FJ1B7zXot4YurjoaXCXHUocQ8q0YBHrXprV+GY2VuF82LA7ZsVWhm6wljzePVLjR70LSQpB8QR8tQpzN3X7yVPSsAYpStPMpt19ToQO4PNj/NHy9tQt2JbDjWtUdF2dt3DyFu5cu7l6ar49PeveV2sYVcUgLflssni4VNJ1WsDXrGg4T3+yr6DFitsbrQ7NVqRxPK4EkacvNTzB/OI8KyxmDs05m5Xl1V/wAH3FmIgnWdFb8pjad5cb4kp79FaHwrGVQ052RekloX7HoxbY79UlNeKeq+R5qeUW+jGjbWvF0TaQhAOgGvCOQOg6+2vClK1ufMlElFaJCvwjWv2uy4My0xZmHJEfDWHbnfHOLhJhRlOIQfylAaJHidBX1JyeiPM5xrjvTei8zqxTpXPbbRMvlwjwLdEfnTpCw2zGjNlxxxR6glI5k+AqZGVO7SxfiFTMvHN0j4WgnmuFFIlSz4aj72j16q9VTfye2csBZGxAnC9jbbnqRwO3WV9+mOjt1cI5A8vNQEp8KlacC2zjL9qKZtHtRg4qcaH3kvLl8fxqRM2X93apl6JibNVhCtNHY2GQriGuvIyVDkR29GNfyj1pqfseO1EYbZZbQ0y2kIQ2gAJSAOQA7B4Vz0qx00QojuwRybP2jkbSt7y+Xoui9BSlKzkYKUpQClKUApSlAKUpQClKUApSlAK43G0PtqQtIWhQKSlQ1BFclKAqf3hO7HXbjdMzMnrYXIhK5V3wpFTzZGmqnoiR1p6yWRzHtBp5ohvsh7HuM9q/HCYVjC7Rh2CtKrniR1tRZiDrCUdXG8exAI7yQOdbFFfKsOGrRhWI7Estsh2mK6+5JWzBYSyhbriipxZCQNVKUSSesmgPHClg+1bDNqs/2Qm3XyCM3F8uuTvSyZHAkJ6R1eg4lnTUntPOvr0pQClKUApSlAKUpQClKUApSlAKUpQClKUApSlAKUpQClKUArGebWWWD8Q4fnz7rhOx3OcACJMy3Muug6jnxKSTSlaeV7BObG/wBUirPPOxW20vSPIbfFh6ON6eTsJb08zwFY+wDGZmXwIkNIfRwK81xIUOrxpSqjL2zvVf8AZ934LPNmnKTA0y0KmSMGYefltrHA+5amFOJ5HqUUaipJxI7UOK2yw2hhpCdEttpCUj1AUpVowvZOMdo/76PapSlSRUBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoD//ZCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldL0ZvbnQ8PC9GMSAzIDAgUi9GMiA0IDAgUi9GMyA1IDAgUj4+L1hPYmplY3Q8PC9pbWcwIDYgMCBSPj4+Pi9QYXJlbnQgNyAwIFIvTWVkaWFCb3hbMCAwIDU5NS4wMSA4NDEuOTldPj4KZW5kb2JqCjcgMCBvYmoKPDwvS2lkc1sxIDAgUl0vVHlwZS9QYWdlcy9Db3VudCAxL0lUWFQoMi4xLjcpPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDcgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjIwMjI0MTg1NjQyWikvQ3JlYXRpb25EYXRlKEQ6MjAyMjAyMjQxODU2NDJaKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxNTQzMiAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2MTcgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDAxNzk1IDAwMDAwIG4gCjAwMDAwMDE4ODQgMDAwMDAgbiAKMDAwMDAxNTYzMSAwMDAwMCBuIAowMDAwMDE1Njk0IDAwMDAwIG4gCjAwMDAwMTU3MzkgMDAwMDAgbiAKdHJhaWxlcgo8PC9JbmZvIDkgMCBSL0lEIFs8MTRmMjhmN2Q5NDdhOTM0MzNiN2QzZWNiZWZlNDRiNjc+PDZhMDJkZTJjODNiZGQyMjViODE4NjE2OTE5NTdiZmI3Pl0vUm9vdCA4IDAgUi9TaXplIDEwPj4Kc3RhcnR4cmVmCjE1ODQ5CiUlRU9GCg=="},"contentType":{"type":"string","example":"application/pdf"},"fileName":{"type":"string","example":"order-162.pdf"}}},"messages":{"type":"array","items":{"type":"string","example":"PDF created"},"example":["PDF created"]},"total":{"type":"number","example":1}}},"examples":{"Order PDF by lookup key - 200":{"value":{"data":{"base64":"JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE1MzQ+PnN0cmVhbQp4nK1Yy3LbNhTd8yvupjPtTAzjTdCryrFbt06dhzXJotMFbdGWHD4UinKarPIp+dRegKBISg7JNk0mdjA65+C+cHGhD8HpPKBgJCNRBPNFcD4PXgcfAkqoCBV8DDj8jp8/BIzCH8Gff1FYBB+AKQr2r5IEQZxBaELCJdxmcLzK7imcFfAaNRRlkYb93+W93fT4FwaGcAXzu4A5NYZ6lEQGjJBEwDwLfnxVFuskTYvyp/mDNe1bPKoIB8PRHFnzVmlRJfmmKuO4Aing5n5YQUbaBsAwRZhxEoyqCJ5fwCzbVEm5iLMRExgnSDBoiWZO4Op8fnH+5sXs6ux6ZG8jiNIYQ01k5KjnR1m8Sk9gld8VP6+bGJA8HbNBExZBGKIvdfwu316egJBMGK3UiBWhIgLJOiRCO/Lp/N0JXL0ghkaYupCwMCSnlI3ISE0UFgTi6ziezq4unQwG6M3s9CWhjDLCKVaM1l6rrqamLjhEXUVbXiJsMvu1oRCjtQ5h/3crEhK1J6OIUf2ygusij0tYbTDU98nmdlkmj0kON6sHWCRwGWdJCY9xDpdFsV7G+SJJocCfJeTbzH6GodUCTwqBi6QCDNiR/wAVr15gQXJhpDYYNQIv1xCnaQIpblHa7XL4vHrIUfBzArP0PsmSPIFudJ/y4QjLrHbibVGUH+O4XKCQtbEqknW82aAygbMENd9v8wq2kMcprnCf9ddlVa1Pjo831mnS1lWyPbaVVmZxtUqOY2/K0WO7AfFmoQGGU3tSskCFEnPZrNNmzRmhEpe8998dahm8C3KbPWj+YcYYJldpQ5hGXW7Qab9K21XEcNUA3WIZ3AVcyhaddYX2wC1wxxWcd7k9qQNCC97xJaVdfk/ugNCCW35ouvye3AGhBe/4SukeP+wFbo/Qgnd8zIjAP7D/u0mIjPBM7RJSr5qEKGrbnI9xs+gkpOF2hPbAHtjl+pDt9u1KHRA8uMv3IWv4PbkDggf3+KHp8ntyBwQP7vJ9jHf8sBe4PYIHd/l7p8JF2rGMPW4O75fpboltVjRZ2a282LcapAgdN8I7m1k7dWRt8Ou0XeN95ALn4X7pItWjNK62Cn7pGfuCbax3At6dRqBZNgJ9Pefe0JUhQgNKGNuObKe83t5URRWn/d4a9W8/Rhjrkk4G0Eq4UmrBMATmPWO+DOq6gaqDZuoZpQMM5yn2Vllf2dfL1Rp7dwW3xabaTPC3pQ77G3ahg97WoWnBw/5GdnzooKe4S7ntYe4KnM3xkvlhgp8tZ9TPFjrBzxY8xc8WLZ/xnp/i0E9pcAqu0fNp1WsZT2VTPGV6Rx6GwLxnyZdBXVe9HTQ/dJP1BhpBIcQzH9VGvyztaHVb5HcrN4sU+YDPruOFOHNEpjcYPhlOag0LFSc86uy0iKtkYAdGTUOTcrR2GHrPe2gujyg/4pTzcdPwxHctwynyJikn2IaFRdVk21o00xOM4sqO8u5BYt8jEC8WZbIZaiuNWcjU422lTiEVhEaHKdzDRvhGEqAN83EaqlnuTluLPUvSFc7cnyY44Kl4noy/O2I3779Nk+19ki6Lu6Gm4NmakbD2/tdkkWTrCi7sS+J9nMdxClyFEzQUavgrgAsJs9P2ITrEjqTdWuNzXo/3ar9VC/7Gk3W/CSvMGJ+cC9FPxm/5Y7G6TSblQnxfMsT/kQ3xPekQyvyrfIj/lBB3jjReouETrXAPq4WbMKLIflsx7SB1wPhwXmxv+5PFQe8A+xLUdZ+5ivtfnOyBWajsLdrinxeLZMggvN466FlW4Bt3yBguu/hX5ephA+vjIfsllnaHgiPGyJUnoy5+7Kq24cHh1l+Q51t8hMdDNeEj1FKi0ESUR4oxnFaGikLRPnGw8mxcWygb1OWuglr030Pu+ufiJCtctlro0EQl6iuqa/PI6Cipnm6JK4Jplsj6yuugxTOmBgh+cpxmiHs8TDOkeTxMD4l/2O/641DfqB+Y+JALxei4VbcNKZEi+xdwllTLYjGUVxaRmqqj0UHW7yP07nzHn9zrZ+o2yDS9XexX36+DfwDszggXCmVuZHN0cmVhbQplbmRvYmoKMyAwIG9iago8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtUm9tYW4vRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjUgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmRvYmoKNiAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0hlaWdodCAxNDYvRmlsdGVyL0RDVERlY29kZS9UeXBlL1hPYmplY3QvV2lkdGggNDAwL0JpdHNQZXJDb21wb25lbnQgOC9MZW5ndGggMTMzOTM+PnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFP/AABEIAJIBkAMBIgACEQEDEQH/xAAeAAEAAgICAwEAAAAAAAAAAAAACAkHCgMGAgQFAf/EAFwQAAEDAgMEBQQKDQgHBgcAAAECAwQABQYHEQgJEiETMUFRYRQiOHEyQlJ0dXaBs7S1FRYZIzc5YoKFkaGy0zM2V1iUlaKxFyRHcnODxBhDY4SSpSZTVpPU1fD/xAAcAQEAAgMBAQEAAAAAAAAAAAAABQYDBAcCAQj/xAA1EQACAgEBBQUHAwMFAAAAAAAAAQIDBBEFEiExQQYTUWFxMoGRobHB0RQi4SMz8DRDUmKS/9oADAMBAAIRAxEAPwC1OlKUApSukZr5t4ayXwlIxFieemJDb81plPnPSXOxttHtlH9QHMkAE18k1Fat8DJXXO2arrWrfJI7vUfM59uLKnJVx6FMvZxBe29UqtdjCZDiFDsWvUIQdesFXF4GoE7T+3LjjN6P9ibU89hLDUkr1gwnCHpDPsR0rw01CvPBQAE+aBz6zE/hqJsz1/t/Eu+J2ZkuOZLTyX3f4+JNjMjep4/vy3WMHWG14UiE6JfkgzpXgdVcLY79Cg+vvjvizapzfxstxV1zFxApLns2YkxURk+HRs8KdPkrF/DThqPlfZPnItVOzcWhf0619X8T2bnfLpe1E3G4zJ5JCiZTynCSBpr5xPPTlXrxJUmA4XIz7sZZHCVtKKSR3cuzlX5w04aw7xvKCS0O9Ydz+zOwksKtGYGJIIB16JF0eLZ9aCrhPWesVnXL7eZ5w4TdQi9vWzGMMHzk3CIGXgPyXGeAA+KkqqKHDThrLG6cfZkaluBjXrSytP3FtOUO8xyzx+6zCxO1KwHcnNAFTj08MqPZ06QOH1rSkeNS0ttziXmAzNt8pmbCfTxtSI7gcbcSe1KhyI8RWvFw1lPJHaVx/s/3RL+Fr04m3lXE/Z5ersN8a89W/anl7NBCuzXTUVv1ZzXCxFYy+zcJJyxZaPwfL4818y9alR12ZNtHB+0ZHTb06Yexg2gl2ySnQelA5lbC+XSJ05kaBQ56jTzjIqpaE4zW9F8Ci3UW403XbHRoUpSvZgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSldNzVzOsuT2Bbpim/PdHBhI1S0kjjfcPsGkDtUo8vDmTyBNfG1Fas9whO2argtW+CR1/PzP/Dmz7g9d3vbvTzn+JFvtjR++zHQB5o9ykagqUeQHeSAaks3s5cVZ7YwXesSTFSXieCLBZ16CKg6eY0js6hz5lR6ya485M379ndjqdia/PffXjwx4iVEtRGQfNab16gNeZ7SST1mumMqMduRJAJ6BorBSrhKVE8KVD1KUk/JVSysuWTLdj7J3HYuxKtkU97YtbWuL8PJfd9T4N7eRKuTpaIU0jRttSRoFJSNOLTs104vWTXocFc3BTgrxqbji3xZw8FOCubgpwU1Pm4cPBTgrm4KcFNRuHDwU4K5uCnBTUbhw8FOCubgpwU1G4edunS7PPjzoEl2FNjOB1mQwsocaWDqFJUOYII11FWk7E23G3m2IeBscOoj4zQ3wxLidEt3QJHUR7V7TmQOStCRoeVVZ8FcsSQ/b5TMmM85GksLS4080spWhYOoUkjqI011HVWem+VMtYkZtDZlW0KtyfBrk/D/PA2GKVGTYh2pE7QGBFWy9PITjayISiaOSfLGupMlI8TyWByCu4KAqTdWaE1ZFSjyOOZOPZiWyptWjQpSlZDWIabxHbZxVsdfaB9rNjs96+2L7IeUfZYOnovJ/JuHg6Naevp1a669Q8aw+dt/bNA57M5+SzXD+JXVt+d/sT/Tf/QVapQEGdmDeawc1cy0ZZ5mYQkZZ46edEaM1JUsMvyDpowtLiUrZdVr5qVahXVxBRSDmbbf2h71svZEysc2G2wLrcGZ8aII9x4+iKXFEE+YpJ1GnfUI99Vhq34bxXlNji18FuxQ/5ZHclM+a66mOphxleve2pxfPn7NPcKznvTbk9edhBm4SWizJlzbW+62faKV5xHyE6UBibCW8K2sse4ehX/Duz5FvVlmpK40+FbJ7rLoCiklKg7oRqkj5K79kPvTzfMzomXOc+ApGWWJJLyIyJbnStsoeXpwIeZdSHGQokAL1UPOGug1VWb9276EuVvvKR9LfqKO+8w5ak2DK/EIZbbv3lUuCHxoHHI/ChfCe1QSvmOwFxXuqAs7lSmYMZ2RIdQxHaSVuOuKCUoSBqSSeoADXWq5McbzXMTNjMa4YN2Z8tRjNEEqS7e7gw68lwcXD0qW0LbSy3r7Fbq/O1GqU9VZH22s2rxhvdtN3VchbN9xPZbVbn3upWsltsyQQefnNh5PeOLXsr726zytt+XmyJhi5sxUN3bE63rtPfGhU5q6tDI17g0hHLsJV1EmgMEI3jufWz3iS2RdorJ9u3YenL6NN0s7K2XAeslKi64y6pI/7sKQdOZPfY1g/Ftnx9ha1Yjw/OaullukdEuJMZJ4XWljUHvB59R0IOoOhFYx2x8soGbmzLmJh+dHRId+w8ibDKhzblMNqdZUD2HjQAe8FQ7TUZtzJmDLxJs6YgwzLdU8nDl7WmJxHUNx320ucA/5oeV+fQHq7Ue8IzWym2o7hlHgDANnxfIS1HXDZWzIdlyFuR0vKSEtuAHTVXUOoV1uTt47X1mYXOuezQ79j2Bxv9FaLgFBA6zqFK0GnPXQ6dddax9+O1w5/5b6pVVqtARe2NNvLCW13Dm29mC5hfGlub6aXYpD4d42tQkvMuaJ40BSgCCAUkjUaEE9I3hm3NizY/vOCYmGrDZry3fWJTr6rqHiWy0poAJ6NaevpD169lRnxxa4uUW+Sw6cKNpit3mdFdmRImgSlUuMUSdU/lcSnTr2q1A6q5t+L/OrKT3lcv349AZA/7b22d/Vn/wDZ7h/ErLmy3tL7RmaObDFizLyX+0jC64jzy7t9jpbPC6keYjidWU+cezrqZ1KAhPtX7c2LMgtqzLvK2z2GzXC0YlYtzsiZODvTtGROdjq4OFYToEtgjUHmTrqOVTYqpXeTfjI8i/edi+uJVW1UAqE+z3tzYszf2z8wcnLlYbNCseHJF2Zjz4od8pdESWGEcfEsp1IOp0A59WlTYqpXYe/GvZ3+/MS/WaaAtqr0LzeIOHbRNutzlswLbCZXIkypCwhtltCeJS1KPUAATrXv1Cfe6Zhy8D7I0m3QnlMuYmvEa0OlBAV0PC5IWPUfJwk6ditO2gMUXzeW5u56Y3uVh2asqhiK1wFcLl5u8Zx1S06nRwpDjbccK0PCHFKJA10B1A/bJvK838isa22x7SuVCcPWuerhbvNojuNFtOvNwArcbfCe0NqSoDnoToDJrd35XQMrNkTL1qJGbal3y3t36a+kDifclJDqVK9Tam0DuCB261+7xDLKBmhshZhsy46HpNkgLv0J5SdVMOxUl1SknsJbDqD4LVQEhLJeoGJLPBu1rlsz7bNZRJjSo6gpt5taQpK0ntBBB1quPN7eSZy4d2mMW5UYBy2s2LpNqmuR4jLceU9LfQhvjUopQ4AdBqeQHIVlTdFZgy8bbIsa3zHVPLw1eZVnZU4dVdFwtyED1DygpGvUE6dQFRsyb/HR4p9+3T6CqgO4XreRbS2WEcXvMLZ0XAwy0QJEhMOdCSjmNNX19IhHcOJPM1NrZj2nMI7VeXSMU4VW7HUy55PcLXK0EiC/prwK05KBHNKhyI7iCBlS52yJe7bKt0+M1Mgy2lsPx30hSHW1ApUlQPWCCQRVUe5+eVYto7OTDdrcUvDqYalI87jBLMstsniHIngcXz7aAtopSlAKql289oJWbGZa8NWqTxYWw44phvoz5smV1Ou+IHNCevkFEezqd+15m+rJjI693aI90F5mgW22kdYfcB84eKEBa/Wkd9U3Kc1JOupNQO0r2kqo+86Z2P2apyln2Llwj69X9vifteE1bX2McR5wfU6jh06igBXF+0pr8JJr7+HsFX3MR+1WLDVolXq7vyHyiPFRxK04WvOJ9qkdqlaADmSKgoJt8DpeRNRrbk9EdJ4PCvu4PwBiLMG6i24asc++zjzLMCOp0pHerQeaPE6CrA8iN2TbLc3HuuaM83OXyX9gbY6UR0fkuvDRSz4I4QNPZKFTZwpgyxYFtDdrw9Z4VltyPYxoLCWUa9+iRzPieZqapwJz4zehzvO7TY9DcMZb78eS/krCy/3Y+ZuJ0IfxFMtWD46utp9zyqSB38Dfmf4xWfsLbq3AVvbQq/4qv16eT1iGlqG0r80pcV/iqblKk4YVMOmpT7+0G0LnwnuryWnz5/MjVbd3fkVBRo9hSTcTp7KTdZQP+BxIr3vufuQf/wBBf+8T/wCPUh6Vn7ir/ivgRr2lmt699L/0/wAkWLzu2slbohYjW27Wgq10VCua1FPq6UL/AG61ijGG6htTqFrwrjuZFWOaGLxDQ8D4Fxso09fCan9SscsWmXOJs1bZ2hU9Y3N+vH6lOeZOwHnBl0h2Qiwt4ogNgkybA75QoAf+EQlwnTuSR41HmVBegyXY8lhyO+2rhcadSUqQodhB6j662Eqxpmzs84AzthLZxXh6NMlFPC3cWk9FMa5cuF1PnaD3JJT3g1pWbPXOt/EsmJ2qnFqOXDVeK4fL+UUacHhTg8Kk7tcbGy9nAwLrbb8i74ducgxoyJaejlNOBJWEKI8xeqUnmOEk8uHq1jQpsoUUqSUqSdCDyIPdULZCVUt2a4nQcXIpzKldRLVM7dk5mld8lcx7Ni6zHWTAd1cYKtEyWTycaV4KSSOrkdD1gVeHgjGNszBwjaMSWd/ym2XOOiSw528Kh1HuIOoI7CCKoO4PCrHN13m+q44fv+XE57Vy2qNztqVHn0C1APIA7krKVet01I4F27Pu3yZU+0+z1bQsuC/dDn5r+H9yelKUqwnLCqvfnf7E/wBN/wDQV2r7rtjj+rDiD+93/wD9fXVd+d/sT/Tf/QVapQFR8LJ/PDeT59YcxZmdhCRl/ljY+EJiS2HGAtjjC1tMpd0W646QEqd0CQEj3ISZM73VsN7GlwSkBKReYAAA6vPVU16hVvePQ3uXwzB/fVQEVNmHbTz/AMrsgcKYdwps93fF2GLbHdTFvzFrnuNSUF5xalBbbZQQFKUnUH2vrr4OU9kx/vZ8+W75jy62u0YIwh0XlNot6yhTcd1ZV0UdslSit0taLeUdAANNdEoqwndu+hLlb7ykfS36gu+79z13mZWSbflzjRziVz4WGoUxzme4CPIST3htH5fMCR++IYbjbIVvZZbS003iSElCEJASkBmRoAOweFZu2A/Q3yn+Bk/vrrqu82y3mZkbHONG7e0p+dZize22kp4iUMOAvHw0ZU6rl7nTtNfD3VeblszG2TcP2NqU2u+YTW7a58biHGhJcW4wvh6+FTakgHtUhY7KAk3mz+CzGXwNN+YXVdW46/mtm379tvzcippbaGacDJ/ZizDv06SiO87aX7fBSo6KclvtqaZSkdp4lcR06kpUeoGo37mrLmZhbZxvmJprKmRia9Lciaj+UjsIDQWP+Z0w/NoCNG13mlMyW3qSsawMOv4tmWlqG63ZozpbcklVuCOEKCFkaBfFySer5azNJ3tWY05hbFs2Zb4i4ODhYU5cJL6Qvs1bTCSVDwCgfGus4+/Ha4c/8t9Uqq1WgK09iTZWzTzC2kbhtIZ425yx3Za3H7daJbJafU8proUqLKiVNNNNeahC/O1CT7XVXQd+L/OrKT3lcv349W1VUrvxf51ZSe8rl+/HoDIH/ZQ29f6wOH/71l//AINSc2O8rs88sbdidrOzHkDHMqY6wq2OQZTr4jISF9KD0jLWnEVI6ters7ZHUoCpXeTfjI8i/edi+uJVW1VUrvJvxkeRfvOxfXEqraqAVUrsPfjXs7/fmJfrNNW1VUrsPfjXs7/fmJfrNNAW1VXVvtPwB4F+Mw+iv1YrUKt7flxLx5sjS7hBaU89he7Rry4htPEos8Lkdz5EiRxnuCNeygM/7Jvos5N/EyzfQWabWXos5yfEy8/QXqxzu5c3LbmvslYFTElNuXHDsFuwz4wUCthcdPRt8QHUFNJbUD2g+Brk3i+advyu2RMfqlSUNTb7BXYYTJVop9ySOjWlPfo0XFHwSaAwFuS/wB46+Mx+isVFfG2ZWL8o96Fj3E2BsHyceYjjXKYhixxGHnnHkrjcCyEtArPCklXIdnOp07pHLmZgPZEhzpzKmXMTXeTemkrTooMlLbDZ9ShH4x3hYPbUacm/x0eKfft0+gqoD4+0NvMtoiFhb7W7nlevKGZfW3GGbnc4UuNJU3oErMcyAhKSONOq9Dw6jqOhEyt3fsaK2T8ubjLvcyLcsZ4lLT852CvpGIzKAromG1+29mpSlDQEkAahAUeHeg5AjO3ZjulxgRumxDg8qvcMpT562Up0lNjwLWq9BzKmkCvDdebQf+m/Zpt9ruEvp8S4OUmzTeNeq3GAnWK6fAtjg1PMqZWaAmDSlKArU3nuYi7vmNh3BzDmsWzwjMfSD/3755AjtIbQgj/iGoU6isp7VWK14w2iswLipZcCbs7EQrvQx94T8mjYrFBOtUzJl3l0peZ+hNk0LFwKal4LX1fF/NnmV1ZTuto7H+ivFsjomxJN64FO6DjKegbITr3ak6D11WjxVYbup72l20ZiWk6BTL8KUnvPGl1J/VwJ/XWxgNLIXvIntOnLZc9OjX1RPqlKVaziIpSlAKUpQClKUApSlAQg3sjbRyKwq4V6PJxI2lLfekxpHEfk0T+uqxLfegUpYmkqbACUPAaqb06tfdJ05adY5adWhsm3tlzS3lngW3cuN+7uyB6m2Sk/OiqwKgMzR2vU6h2fbhhRkn1f1O1raUjhOoUhQ4krTzCh3j/+8DWXNkrMBeWe0Lgu7FzgivTU2+Xz83oX/vSie8JKgv1pFYLtF3ML7w8C5EWdSkdaD7tPjy5jqI5dYBHYE8bDiHGnCCNFtuoJHqUP86i+NUlJF00hm0zpn1TT960NgClddy9xMnGmAsNYgT1XW2xpw5afyjSV9X51diq5J6rVH59lFwk4y5oh9vA9iK+bZBwGLNiW34d+1zy/pfLmVudN5R5Ppw8PVp0B117xUwaUr6eRWBttPZ1uO1HkfJwLarvFskt6dHliXMbUtADaiSNE89TrWeaUBinZcyemZBZC4RwBcLgxdZlkYcZcmRkFLbpU845qArmPZ6Vi3b02Kk7YeE8OMW66xbBiSxy1rYuEtpTiFRnEaOtEJ581JaUD2cJGnOpUUoDouTmEr/hLKTDeGcY3ONiG+W6AmBMuDKD0csIHAlZCuZKkBPFr1niqEGY262xTgrMaZjTZxzLcy5kzCortEl59lloFXEW0PNBRUzrp97WhQGg5nkBYzSgKz4G7EzfzmxVbZ+0LnOcSWiAsKTbLRJkSStPalCnUNoYKgOaktqJ/aLGMK4VtWCMOWzD9igNWyzWyOiJEhsDRDTSBolI+QdZ5nrNfYpQEPsR7EV8ve3rbM/kYlgNWeJ0XFZ1Mr8oVwQzH5K9j1nX1VMGvQu16t9giKl3OfGt0UEJL8t5LSAfFSiBXVbfnnlvdpSI0HMDC02Sv2LMe9RlrPqAXqaA7zUM9v7YUvu2Jd8GTLNie3YeTYWJTTiZzDjhd6VTZBHD1adGevvqZKFpcQFJIUk8wQddRXnQFav3PXan/AK12IP77un8asp7M+yBnvlLm9asS45z8u2PMORmn0P2OVc577byltKShRS64UHhUQrmOzlU16UBBfbe3fmLdqHO3D2PsNY3g4UctFnj29rpW3enQ81JfeDqFoI4dOmToQdQU61j37nrtT/1rsQf33dP41WVUoCL+x1s45sZE3LFD+ZOblxzNYuTUdEJqdOlyREUgrK1Dp1q04uJI5aa8POo24x3XWaz+emOcxMFZxs4LlYivE+4NuWsyoslpmTIU90SnGlJJ606gHQlNWZUoCtX7nrtT/wBa7EH993T+NUy9nvKLEeXuR0XBOZGKHMyLqrypufc7k67J8rZdWr72svFSlJCFcGhJGnLqrL9KArZxTuucf5WY5uGI9m/Nh3BDE4+fablJkMpbTqSGy80lfTIBJ4Q42SO1SjzrxwzuvMx81sc22/7R2bS8aQ7erVNotsqQ+l1GupbDrqW+hQrQcQbb1PPQg+dVlFKA9K0WqHYbVDtlujNQYENlEeNGYSEoabQkJQhI7AAAAO6ogYI2Fb7hTbru+fTuJrc/aZr8t1NoQwsPp6aOWhqr2PInWpmUoDieaRIaW24hLjaxwqQoahQPWCO2oVbK2wTiTZW2iMTYssWLre/l/ehIYOHyy4H22CsuRhxexK2jonXlqkq79Km1SgFKUoCgjEd1N6xBc7iTqZcp1/UjTXiUVa/tr5nFXJLYXClPMO/yjS1Nq0Oo1HL/ADFeuV91UbQ/SKaSSXI8ye+pbbszGaLFn/Jsjrmjd9tTzLSdet5opeH+BD1REJ1rtuUWPXcr8zsMYqZClfYqe1JcQnrW0D98T+cgqT8tZ6Z93ZGXgRu0aP1WJZT1knp69PmXx0r1YM6Pc4UeZFdRIiyG0utOoOqVoUNQR4EGvaq5HABSlKAUpSgFKUoBSlKArD3s+Kkz8xcD4bS4FG22x6cpI9qZDgTz+SMDp2Dn21AsprOW2XmGjM/aRxpdmHA5BjyvsdFUk6gtxx0XED2hSkqV+dWEiKrN09+yTR2LZ2O6MOqD56fXievX2rJdw2kQ5J+8k/enD1tK7v8AdPd2HmO0H5RTXGRpWFpSWjJGMnXJSjzL0NkSU7M2a8v1PpWhxu3BgpcGhAbWpA/YkfJWYqwRsONPMbKWXKX+azAWoaq180vOFP8AhIrO9Wer+3FeSOM5r1yrX/2f1KgN95+FPLX4GkfP1WtVlO+8/Cnlr8DSPn6rWrKaRtUUpSgFRU3o/oK5mfoz6ziVKuoqb0f0FczP0Z9ZxKAoCq9PdD+hvbfhmd++mqLKvT3Q/ob234ZnfvpoCatV47wXeVuZH3OXlzlg5Hl42aHDc706hLrNrJAIabSdUuPaHU8QKUdRBVqEyu2s87Rs8bPuMsdI4FXCBE6O3tucwuW6oNM6jtAWtKiPcpPVWuFc7nLvdylXC4SXZk6W6t9+Q8oqW64olSlKJ6ySSSaA+1jzMjFWaN9cvOL8Q3LEd0XrrJuMhTygDz4U8R81PgNAOwV1qp5bujd72/aagT8dY9emRsExJBhw4MNfRu3J5IBcJX1paRqkap5qUSARwHWwPFO632csR2BdtjYIdw+/wcLVxtl0k+UNeP31xaVH/fSqgKcchNrzNTZwujD+DsUym7ahQU7Y5qy/b3x2gsqOiSfdI4VflCrxtkDa4wztcZd/Zu1JFsxBA4GbzZFr4lxHSOSkn27S9FFKtOwg6EEVRntWbON42Wc5Lrge6yPL46EJl265BHAJsRevA5w6nhOqVJUOeikK0JGhPYNhjP6Vs7bSGFb+ZSo9hnSE2u9NlWiFw3lBKlqH/hq4XR4t6dpoDYnqgHej+nVmZ+jPqyJV/wBVAO9H9OrMz9GfVkSgMf7FHpb5Q/GaD86mtj6tcHYo9LfKH4zQfnU1sfUBH/b89DfNj4GV++itdetijb89DfNj4GV++itdegLqdyp6LOKfjnK+gwa+rvkvRHh/GaF8zIr5W5U9FnFPxzlfQYNfV3yXojw/jNC+ZkUBSDWwnu3fQlyt95SPpb9a9lbCe7d9CXK33lI+lv0BGrfefgsy0+GZPzAqoGrft95+CzLT4Zk/MCqgaA/QSk6g6HwrKWWm1Hm1k/Nak4TzBvtrDZ4hFMtT0VR/KYc4m1fKk1aJkXutsjMxMisvcT3WHfRd77hu33KW7HuhSnpnorbiylPCQBxKOg5gVHjbY3V/+gvBE7H2W94n37DltT0tztd14FS4rXa+hxCUhxCdfOHCFJHPVQB0AkvsN70G357XaDgTMhiHh7G0jRuDcmDwQ7mvsb4T/JPHsGpSo8hoSEmwGtVyPIcivtvMuKadbUFoWg6KSRzBB7DWwTu9tpB/aU2c7Td7tI6fFNmcNovCyfOdebSCh4/8RtSFE6AcXGB1UBV7nbYFYTzjxvZ1JKBCvUxlA5c0B5fCfURoeyuklVSe3jWBF4P2krjcUo4YmIYbFxbI6gsJ6JweviaKvz6i6TVOuhuWSj5nfcHIWRi12rql9DyKq/Cda8CvurxJNY9Da3i3Hd4ZzozLyNj2CXI6S94UKbe6lR85UY6mOr1cILf/ACvGpU1SPsoZ9PbPmcNtvzilqsUr/UbuwjnxxlkarA7VIUErHaeEp1Gpq623T412gx5sN9uVEktpeZfaVxIcQoapUk9oIIOtWfDt7yvR80cd2/g/pMtziv2z4r16r4nt0pSt4rQpSlAKUpQCsTbUObjeSWSOJcTpdDdySwYttTy1VLd81sgdvCSVke5Qqss1VbvJs+hmBmPHwJapAcsmGVEylNnUOzzyX6w2PM8FFzr5Vq5Nvc1t9ehM7IwXn5ca2v2ri/RfnkQvc1WoqUdVE6knmSa4ymvYKa8CnWqxqdkcT1imvApr2Cmu25PYBdzPzVwphVtKiLtcWYzpT1oaKvvq/wA1AUr5K9ri9DWsahFzlyXEuy2dsNqwjkTl9Z3EdG9FsUNLyNNNHSykuf4iqsjV4IQlptKEJCUJGgSBoAK86tqWiSOHTk5zc31epUBvvPwp5a/A0j5+q1qsp33n4U8tfgaR8/Va1fTwbVFKUoBUVN6P6CuZn6M+s4lSrqKm9H9BXMz9GfWcSgKAqvT3Q/ob234Znfvpqiyr090P6G9t+GZ376aA6Jvq8UPW7IHBtjbUUN3PEIfdI9slmO5on1cTiT+aPlpnq2jfi/zWyk9+3L5uPVS9AbF+wnhCPgnZAyngRkJQmRYY9zVw9q5SfKVH16ums81inZN9FnJv4mWb6CzWVqAqy34GEWDByqxQhtKZSXZ1tec7VoIacbHqBDv/AKjVUlW/b7z8FmWnwzJ+YFVA0Bs0bP2KXccZEZc4hkudLJuuHLdNeXrqS45GbUvXx4iapB3o/p1Zmfoz6siVcnsU+iPlB8WYPzKaps3o/p1Zmfoz6siUBj/Yo9LfKH4zQfnU1sfVrg7FHpb5Q/GaD86mtj6gI/7fnob5sfAyv30Vrr1sUbfnob5sfAyv30Vrr0BdTuVPRZxT8c5X0GDX1d8l6I8P4zQvmZFfK3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrIOKMOwsX4Zu9iuLfS2+6RHYUls+2bcQULH6lGsfbJvos5N/EyzfQWaytQGrBcIK7bPkxHSlTjDqmlFPUSkkHTw5VZbuQ8XyI+O8zMLFalRZdti3MI9qlbTqmyfAkPj18I7qryzSaQzmbi5ptCW20XeWlCEjQJAeXoB3DSprblT0psU/EyV9Og0BODeaZTKxjk/BxhCYLlwwvI4nikecYjxCXPXwrDSvAcRqq0nvrYIxDYYOKbDcbNdI6ZduuEdyLJYX1ONrSUqSfWCaozz5yhuWReaV7wjcQtYiO8USSpOgkxlc2nB6xyOnUoKHZUFn1aSVi6nSuzGcp0yxJPjHivR/z9ToRVXiVV414lVRWhdnI8tTVh+7j2r0BuNlLiuYEqB/+H5jyuvXmYhPf1lHyp9yKrsKq/WZDkZ5DzTi2nW1BSHEEhSVA8iD2HXtFbFNjplvRIvPxK8+h02e5+D8TYjpUMNiHbfYzfixcEY3lNxsbsI4Ys1eiUXVAH6g8ANSn23WO0CZ9WauyNsd6Jx7KxbcO11WrRr5+aFKUrIagpSsc54524fyFwJKxLf3Cvh+9xILagHZjx9i2jX9ZPUBqefVXmUlFb0uRkrrndNV1rWT5Ix/tl7SkfZ+y3dRAeQrGN3Qpi1R+stctFyFDuQDy161cI0I4tKc5Lzsp9x59xbzziitbjiipSlE8yT2nt1Nd3zezUv2dWO7hirEMjpZkk8LbIJ6OMyD5jTY7Ep1+Ukk6kknpJGtVbJyHfPVclyO1bI2VHZmPuvjOXN/b3HrlOlcZTXslNcak1rJkw4nrkVODda5SLvmY16zAlM/6jYo5hQ3D2ynk6K0/3WuIH/iioYWiyzcQ3eFardHXMuM15EePHbGqnXVq4UpHiSQKvA2c8nIuRGUNiwkz0bkthvpp8hvqflL5ur8Rr5o/JSmpLCq7yzefJFP7R5axsXuU/wB0+Hu6/gyfSlKsRykqA33n4U8tfgaR8/Va1WU77z8KeWvwNI+fqtagNqilKUAqKm9H9BXMz9GfWcSpV1FTej+grmZ+jPrOJQFAVXp7of0N7b8Mzv301RZV6e6H9De2/DM799NAYZ34UZxWDcp5ARqyifcG1K7lKbYIH+FX6qqSq7DfLYHexDsw2m/x2uNWH7+w8+vT2DDzbjJP/wBxTAqk+gNlLZN9FnJv4mWb6CzWVqjPu48xouZOx5l88w8lyTZon2Clt8WqmXIx6NKT3atBpYHctNSYoCtXfefgsy0+GZPzAqoGrPN9vmPEn4qy2wNGeC5VtjSrrNbSrUJ6ZTbbIPcdGXT6lDv51kR47kp9tlltTrrighCEDVSieQAHaaA2Odi1tTWyVlClSSlX2sQFaHuLKSD+o61TXvR/TqzM/Rn1ZEq9HKTCCsvsqcGYWWAFWOywrYQDxAFlhDfX2+x66o13p0N2Nty5huOJ0RIbtrrZ70/Y6Mj/ADQoUBjjYo9LfKH4zQfnU1sfVrd7GsxmDtYZQvPuBpsYot6eI9QKn0JH7SBWyJQEf9vz0N82PgZX76K1162F94rd27JsW5pyHdOFy3tRhqrTznZDTQ/ascv8q16KAup3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMivS3L8B2HspX11waIlYtlvNnvSIsRH+aFV7u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrK1Yp2TfRZyb+Jlm+gs12TOHMaDlFlZivGdycQ3DsduemnjOnGpKTwIHipXCkDtKhQGtbmPMRcsw8US2goNSLpKdSFciAp5RAPjzqb+5VZcVtP4rdCSWk4OkoK+wEzYRA/Yf1VAB11ch1bjq1OOLPEpajqST1kmrTNyFl490+ZuOnmuGPwxrLFd09mrm8+nw0Hk58eLwoC1iou7dOy7/p8wAm72KOlWNrE2pcMDQGazrquOT39aka+21HLjJqUVKxzgrIuMjZxsizFtjdU+KNd19pyM8408hTTqFFK21p0UlQPMEdhrj1FWW7eGw6vFqp+ZOXsLivYBeu9kjp5zABzfZA63fdI9v1jztQqs5WoJB1BHLSq1bTKmW7I69g59WfUrK+fVeDPIqrx4q8eKvEqrFob28czEl2I+2+w6tl9pQWhxtRSpCgdQQew689RViWyfvJG+hh4UzcklK06NRcU8OoV3CUB1Hs6QdfLiA5qNcpVXjxVsVWSqlrEjczDpzq9y1ej6r0Nie33GLdoLEyFJamQ5CA40+wsLbcSeYUlQ5EEdor26o82dtqnMvIi4JjYXnG52Qq437FcNXYhB5FQ5joTqR5ySka6cWoGlSxzF3nFzueEI0XCOG0WTEL7X+tzJbyZLcRfaGRwgOH8pQ0HuVddSv66pR1nwZSH2azZWqFC3ovry09f41JZbQO0xhLZ7sJkXiR5be32yYVkjKHTvnmOI+4RqPZHuOmp5VUtnPnPibPPGL2IMSy+kcOqY0NokMRG9fYNp7B3nrJ5kk113EeILni69S7veZ79zuktZcflSVla1nxJ8OWnUByHKvlEd9QWTmSyHpyj4HS9kbBp2VHe9qx839l4fVnrlNcZTXslNeBTWnqT7iespOlcZTXslNS92K9il7NmZFxrjOMuPgtlfHFhLHCq6KB/WGQRzPtuodpGequV0t2BFZuVTg0u656JfPyRkjdybLS4QazZxPE4XXEKTYIjydCEEaKlEeI1SjXsKlac0mrBa4WGG4rKGWUJbaQkJShA0SkDqAHdXNVtpqjTBQicOz82zaF7vs68l4LwFKUrMR5UBvvPwp5a/A0j5+q1qt93rOy7mjn9mDga4YAwjJxJDt9reYkusPsthtZd4gD0i09ndUFvub20j/RbcP7bE/jUBKr7uLfP6JLf/AH4v+BT7uLfP6JLf/fi/4FRV+5vbSP8ARbcP7bE/jU+5vbSP9Ftw/tsT+NQFgmynvUrptIZ+YWy6kZdw7EzevKuKe1dVvKa6GK8+PMLSddei4esdevhWZd6P6CuZn6M+s4lQb2AtifOzKLa2wJizF+AZllw9b/L/ACmc7JjrS30kCQ0jkhwk6rWkch21YTt+5b4kzc2SMd4TwjanL1iG4eQeSwWlpQp3o58d1fNZAGiEKPMjqoDXdq9PdD+hvbfhmd++mqwPub20j/RbcP7bE/jVbbu2spcW5KbMkHDONbK7Yb43dJb6obziFqCFqBSrVClDnp30BnPOXK+2Z05V4owPeOUC+QXIinAniLSyNW3QPdIWErHikVrb5p5Z3/JzMG+YOxPDVBvVokKjvtkHhXp7FxBPskLSQpJ7UkHtrZ8qM+2LsLYM2ubM1ImOHD+NILJbgYgjNBauHrDT6OXSt6nUDUFJJ4SNSCBTzsf7bGMNkDEM120Rmr/hm5FKrhYJbpbbdUnkHG1gHo3NOXFoQR1pOg0mrijfe2/7X3BhzK6SL4tGiDdLmkxmld54EcTg8PN17xUTc092Pn/lnPdQzg9WL7cFEN3DDbokpc/5XJ1Pyo08TWIbpsw5wWOzz7rdMq8Z2u2QGVSJUydYJTDTLafZKUpbYAA6yewc+ygOvZrZo4izozAvWM8VTjcL5dXumfd00SkABKUIT7VCUhKUjsAFST3ZWzLMz42g7Xfp0NasH4Pfauk99SfMdkJPFGYHeVLSFEe4QrXTUaw+q3zdV7Y2X72C7RkvOtUDBeKGVkwpDOoYvrqvZLUpRJEk6AEKOigEhGgAQALLKqS30uRsuHivCebECKpdumxhY7m6gcmn2ypbC1f76FLTr1DoR3jW22uu4/wDYM0sG3bCuKLY1drDdGTHlRHtdFpPPUEc0qBAIUCCCAQQQKA1grfPk2qdHmxHlxpcdxLzLzZ4VNrSQUqB7CDodatHyx32Rg4XhxMeZfP3K+MNBD1ys01DbcpQ9uWVI+9k9ZAURr1ADkMf7RG55zAwjd5U/KiSxjXD61FTVtmSG41xjp9ySspbdA90Ckn3PfFK7bG2e1klGPIygxq4sdsOxyJKP/U0hSf20BmjbZ3j192ssPRMJW3D6cI4PZkJlvx1SzIkzXU68HSKCUpShPFrwAHzgCVHQAQ7ixXp0pqPHaW/IdUG22mklSlqJ0AAHWSeWgrP+B937tB49lNswcrr3bkq63r42LchA7z05QfkAJ8DVk+xJuurVkHfIWN8w5kPFONI33yDBjIKoNtc/wDmAqALro7FEAJPMAkBQAkVsWZKv5AbM+CcHz2w3eGYqpdyA6xKfWp1xBPaUFfBr3IFYG3yXojw/jNC+ZkVOqoj7zjJ3GWeOzjGw5gaxvYhvSb9GlmIy42hQaS28FK1WpI5FSe3toCg+thPdu+hLlb7ykfS36qA+5vbSP8ARbcP7bE/jVc9sPYBxBlbsr4Awrim2uWe/wBtivNyoTi0qU0TJdWBqkkHzVJPInroCJe+8/BZlp8MyfmBVQNXfb1nILH+fuX2BbfgDDb+JJlvubz8lph5pvo0Ka4QT0ik9vdVav3N7aR/otuH9tifxqAkDllvib1llldhPB0fLKBOGH7NEtDU127rT0vQMoaDikBrlrwa6BXhr21H/aj2+8ztqqG3aL89DsWFWnQ8mx2ZCkNOrHsVPKUpSnCOwEhIPMJB51+p3bm0itQSMrZ4JPWqdDA+erKWWe58zwxdMa+2j7C4Eg8Q6VcyaiZICe9DccrSo+CnE+ugIbYFwRfMysXWrC+Grc9db7dHxHiQ2BqpxZ/YABqSToAASdADWxRsoZAQtmXIvDmBoy25E2M2ZNzmNg6SZjminVjt4ddEp158KE611XZR2HMvdky2rdsbLl6xXJa6KZiO4IHTrTrqUNJHJpH5KdSdBxKVoNJF0ApSlAKhptb7vu0ZxuzMV4HMewY0Xq5IjL82JcVdpVp/Jun3Y5KPshzKhMulY51xsjuyRtY2VbiWKyl6P/OZr343wBiPLfEj9gxPZpdmvDJ0VFkt6KI7FJPUtJ7FJ1B7zXot4YurjoaXCXHUocQ8q0YBHrXprV+GY2VuF82LA7ZsVWhm6wljzePVLjR70LSQpB8QR8tQpzN3X7yVPSsAYpStPMpt19ToQO4PNj/NHy9tQt2JbDjWtUdF2dt3DyFu5cu7l6ar49PeveV2sYVcUgLflssni4VNJ1WsDXrGg4T3+yr6DFitsbrQ7NVqRxPK4EkacvNTzB/OI8KyxmDs05m5Xl1V/wAH3FmIgnWdFb8pjad5cb4kp79FaHwrGVQ052RekloX7HoxbY79UlNeKeq+R5qeUW+jGjbWvF0TaQhAOgGvCOQOg6+2vClK1ufMlElFaJCvwjWv2uy4My0xZmHJEfDWHbnfHOLhJhRlOIQfylAaJHidBX1JyeiPM5xrjvTei8zqxTpXPbbRMvlwjwLdEfnTpCw2zGjNlxxxR6glI5k+AqZGVO7SxfiFTMvHN0j4WgnmuFFIlSz4aj72j16q9VTfye2csBZGxAnC9jbbnqRwO3WV9+mOjt1cI5A8vNQEp8KlacC2zjL9qKZtHtRg4qcaH3kvLl8fxqRM2X93apl6JibNVhCtNHY2GQriGuvIyVDkR29GNfyj1pqfseO1EYbZZbQ0y2kIQ2gAJSAOQA7B4Vz0qx00QojuwRybP2jkbSt7y+Xoui9BSlKzkYKUpQClKUApSlAKUpQClKUApSlAK43G0PtqQtIWhQKSlQ1BFclKAqf3hO7HXbjdMzMnrYXIhK5V3wpFTzZGmqnoiR1p6yWRzHtBp5ohvsh7HuM9q/HCYVjC7Rh2CtKrniR1tRZiDrCUdXG8exAI7yQOdbFFfKsOGrRhWI7Estsh2mK6+5JWzBYSyhbriipxZCQNVKUSSesmgPHClg+1bDNqs/2Qm3XyCM3F8uuTvSyZHAkJ6R1eg4lnTUntPOvr0pQClKUApSlAKUpQClKUApSlAKUpQClKUApSlAKUpQClKUArGebWWWD8Q4fnz7rhOx3OcACJMy3Muug6jnxKSTSlaeV7BObG/wBUirPPOxW20vSPIbfFh6ON6eTsJb08zwFY+wDGZmXwIkNIfRwK81xIUOrxpSqjL2zvVf8AZ934LPNmnKTA0y0KmSMGYefltrHA+5amFOJ5HqUUaipJxI7UOK2yw2hhpCdEttpCUj1AUpVowvZOMdo/76PapSlSRUBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoD//ZCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldL0ZvbnQ8PC9GMSAzIDAgUi9GMiA0IDAgUi9GMyA1IDAgUj4+L1hPYmplY3Q8PC9pbWcwIDYgMCBSPj4+Pi9QYXJlbnQgNyAwIFIvTWVkaWFCb3hbMCAwIDU5NS4wMSA4NDEuOTldPj4KZW5kb2JqCjcgMCBvYmoKPDwvS2lkc1sxIDAgUl0vVHlwZS9QYWdlcy9Db3VudCAxL0lUWFQoMi4xLjcpPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDcgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjIwMjI0MTg1NjQyWikvQ3JlYXRpb25EYXRlKEQ6MjAyMjAyMjQxODU2NDJaKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxNTQzMiAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2MTcgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDAxNzk1IDAwMDAwIG4gCjAwMDAwMDE4ODQgMDAwMDAgbiAKMDAwMDAxNTYzMSAwMDAwMCBuIAowMDAwMDE1Njk0IDAwMDAwIG4gCjAwMDAwMTU3MzkgMDAwMDAgbiAKdHJhaWxlcgo8PC9JbmZvIDkgMCBSL0lEIFs8MTRmMjhmN2Q5NDdhOTM0MzNiN2QzZWNiZWZlNDRiNjc+PDZhMDJkZTJjODNiZGQyMjViODE4NjE2OTE5NTdiZmI3Pl0vUm9vdCA4IDAgUi9TaXplIDEwPj4Kc3RhcnR4cmVmCjE1ODQ5CiUlRU9GCg==","contentType":"application/pdf","fileName":"order-162.pdf"},"messages":["PDF created"],"total":1}}}}}},"404":{"description":"Order PDF by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"0"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:37:05 GMT"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d4a18d-97a2-4285-8489-caf58535cb4e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [395] not found"},"example":["Order with id [395] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Order PDF by lookup key - 404":{"value":{"error":{"code":15001,"messages":["Order with id [395] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/order-update-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/orders/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update order headers details. This request does not support updating orderitems. An order `address` can be updated using the order address endpoints.

Orders are referenced by a lookupKey / lookupId combination

| **lookupKeys** |
| --- |
| `id` |
| `sourceId` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1600"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"exportDate":{"type":"string","example":"2022-02-24 19:38:19"},"exportMessage":{"type":"string","example":"ERP order id: 50001"},"exportStatus":{"type":"string","example":"EXPORTED"},"externalId":{"type":"string","example":"50001"},"status":{"type":"string","example":"ARCHIVED"}}},"examples":{"Order by lookup key":{"value":{"exportDate":"2022-02-24 19:38:19","exportMessage":"ERP order id: 50001","exportStatus":"EXPORTED","externalId":"50001","status":"ARCHIVED"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Order - 200 / Update Order postage data - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"1905"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 15:47:51 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fcbdb98f-f9ef-4b57-a63b-0e5a60b87d09"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"SV"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":"sander123@propel.us"},"firstName":{"type":"string","example":"Sander"},"fullName":{"type":"string","example":"Sander Vleugelhof"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14711},"lastName":{"type":"string","example":"Vleugelhof"},"login":{"type":"string","example":"sander123@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"undefined"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-02-24T14:14:55"},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":""},"externalId":{"type":"string","example":"50001"},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"id":{"type":"number","example":162},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81752},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":5},"postageNet":{"type":"number","example":6.05},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81753},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"siteId":{"type":"number","example":100037},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"ARCHIVED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"21":{"type":"number","example":3.15}}},"totalGross":{"type":"number","example":20},"totalNet":{"type":"number","example":24.2}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14711}}},"messages":{"type":"array","items":{"type":"string","example":"Updated"},"example":["Updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Order - 200":{"value":{"data":{"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"50001","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"ARCHIVED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},"messages":["Updated"],"total":1}},"Update Order postage data - 200":{"value":{"data":{"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"50001","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"ARCHIVED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},"messages":["Updated"],"total":1}}}}}},"400":{"description":"Update Order - 400 (invalide fieldname)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Thu, 24 Feb 2022 18:46:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a7b7ade4-1d73-41e5-8cee-d359132a1f58"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [Date] is not permitted"},"example":["#: extraneous key [Date] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Order - 400 (invalide fieldname)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [Date] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Order - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 01:21:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"62ae4fed-c086-4764-a970-aa5be35fb988"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [1600] not found"},"example":["Order with id [1600] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Update Order - 404":{"value":{"error":{"code":15001,"messages":["Order with id [1600] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Orders

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/orders.tag

<LegacyBanner />



Order API exposes endpoints for creating, updating and searching orders. Additionally, endpoints for processing orders and managing order shipments are available.

## Fields

An order resource contains the fields below:

- fields available when creating an order via the API are marked in the **Create via POST** column.
- a smaller subset of these fields is updatable using the API, these are marked in the **Update via Patch** column.
    

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `id` | `order` id | integer | x |  |  |
| `shop` | `shop` identifier | JSON object | x |  |  |
| `status` | `order` status | string | x | x | x |
| `channelId` | `channel` id | integer | x | x |  |
| `shopId` | `shop` id | integer | x |  |  |
| `source` | external system | string |  | x | x |
| `sourceId` | external system unique id | string |  | x | x |
| `userId` | customer `user` id of | integer | x |  |  |
| `debtorId` | customer debtor Id | string | x | x |  |
| `firstName` | customer first name | string | x | x |  |
| `middleName` | customer middle name | string | x | x |  |
| `lastName` | customer last name | string | x | x |  |
| `email` | customer email | string | x | x |  |
| `type` | `order` type | enum  <br />  <br />dropshipment  <br />stock  <br />purchase  <br />quotation | x |  |  |
| `remarks` | `order` remarks | string | x | x |  |
| `reference` | `order` reference (e.g. po number) | string | x | x |  |
| `extraInfo` | `order` extra info | string | x | x |  |
| `language` | locale in which the `order` was created (e.g. EN-US) | string [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | x | x | `x` |
| `date` | order date | date | x | x |  |
| `orderSource` | `order` was create via which medium (webshop / backoffice / API) | string | x | x | x |
| `externalId` (deprecated) | external `order` id | string | x |  | x |
| `itemCount` | total number of `orderItems` | integer | x |  |  |
| `exportDate` | `order` export date | date |  | x | x |
| `exportStatus` | `order` export status | enum  <br />  <br />EXPORTED  <br />FAILED |  | x | x |
| `exportMessage` | `order` export message (e.g. a success or failed message) | string |  | x | x |
| `merchantCost` | costs calculated by a marketplace (e.g. Amazon) | integer | `x` | x |  |
| `accountingId` | identifier for accounting purposes | string | x | x |  |
| `trackTraceCode` | Track and trace codes of the `order` | string |  | x |  |
| `paymentData` |  | JSON object ([paymentData](#payment-data)) | x |  |  |
| `total` | object containing various calculation of summed items | JSON object ([total](#total)) | x | x |  |
| `postageData` |  | JSON object ([postageData](#postage-data)) | x | x | x |
| `clientData` | `user` / `contact` or `customer` object | JSON object | x | x |  |
| `invoiceData` | invoice `address` | JSON object | x | x |  |
| `shippingData` | shipment `address` | JSON object | x | x |  |
| `items` | order items | array ([items](/reference/legacy/rest-sonar/orders#items)) | x |  |  |

## Payment data

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `payMethod` | method of payment, e.g. creditcard, on account, direct debit. The value should match the paymethod configured in the Propeller backoffice | string | x | x |  |
| `grossAmount` | cost of the payment excluding VAT (e.g. creditcard transaction costs) | integer | x | x |  |
| `netAmount` | cost of payment including VAT | integer | x |  |  |
| `payStatus` | status of the payment | string | x | x |  |
| `payStatusDate` | date of payment processing | date | x |  |  |
| `transactionId` | Identifier of the transaction, often this is an id returned by the payment service provider | string | x | x |  |

## Total

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `discountPercentage` | discount percentage on the total `order` amount | integer | x | x |  |
| `discountValue` | discount amount on the total `order` amount | integer | x | x |  |
| `totalNet` | total `order` amount including VAT | integer | x |  |  |
| `totalGross` | total `order` amount excluding VAT | integer | x |  |  |
| `tax` | total VAT amounts per Tax percentage of the combined order items | JSON object | x |  |  |

## Postage data

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `requestDate` | `order` requested delivery date | date | x | x | x |
| `shippingMethod` | method of shipment, e.g. regular, dropshipment, pickup, etc. The value should match the shippingmethods configured in the Propeller backoffice | string | x | x |  |
| `postageTaxCode` | postage/shipping costs tax code | enum  <br />  <br />`H` = High  <br />`L` = Low  <br />`N` = None |  | x |  |
| `postageTaxPercentage` | postage/shipping cost tax percentage | integer | x |  |  |
| `postage` | postage/shipping costs excluding VAT | integer | x | x |  |
| `postageNet` | postage/shipping costs including VAT | integer | x |  |  |
| `partialDeliveryAllowed` | is partial delivery of the order allowed | enum  <br />  <br />`Y` = Yes  <br />`N` = No | x | x |  |
| `carrier` |  | string | x |  |  |
| `pickUpLocationId` |  | integer | x |  |  |

## Client data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `user` resource | all fields related to a `user` / `contact` / `customer` resource | [user](/reference/legacy/rest-sonar/users) | x |  |  |
| `contact` | a reference by lookup key to an existing `contact` resource | JSON object |  | x |  |
| `customer` | a reference by lookup key to an existing `customer` resource | JSON object |  | x |  |
| `user` | a reference by [lookup key](/reference/legacy/rest-sonar/users#user-lookup-keys) to an existing `user` resource | JSON object |  | x |  |

## Invoice data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `address` | invoice address | JSON object (address) | x | x |  |

## Shipping data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `address` | shipping address | JSON object (address) | x | x |  |

## Items

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `type` | `orderItem` type | enum  <br />  <br />product | x | x |  |
| `product resource` | all fields related to a `product` resource | [product](/reference/legacy/rest-sonar/products) | x |  |  |
| `childItems` | `product` child items | array\[[products](/reference/legacy/rest-sonar/products)\] | x |  |  |
| `name` | `orderItem` name | string |  | x |  |
| `quantity` | `orderItem` quantity | integer |  | x |  |
| `price` | `orderItem` price | number |  | x |  |
| `originalPrice` | `product` default price | number | x |  |  |
| `notes` | `orderItem` notes | string |  | x |  |
| `sku` | `product` sku used for [product lookup](/reference/legacy/rest-sonar/products#product-lookup-keys) | string |  | `x` |  |
| `supplier` | `product` supplier used for [product lookup](/reference/legacy/rest-sonar/products#product-lookup-keys) | string |  | x |  |
| `supplierCode` | `product` suppliercode used for [product lookup](/reference/legacy/rest-sonar/products#product-lookup-keys) | string |  | x |  |
| `source` | `product` source used for [product lookup](/reference/legacy/rest-sonar/products#product-lookup-keys) | string |  | x |  |
| `sourceId` | `product` sourceId used for [product lookup](/reference/legacy/rest-sonar/products#product-lookup-keys) | string |  | x |  |
| `turnoverGroup` | identifier for accounting purposes | string |  | x |  |
| `discountAmount` | sum of all item incentives applied by business rules | number | x |  |  |
| `discountAmountTotal` | discountAmount \* quantity | number | x |  |  |
| `discountPercentage` | discountAmount percentage of the item price | number | x |  |  |
| `discountAmountNet` | discountAmount + tax | number | x |  |  |
| `discountAmountTotalNet` | discountAmount \* quantity + tax | number | x |  |  |

## Order Lookup keys

| **identifier** | **Description** | **Type** |
| --- | --- | --- |
| `id` | Propellor `order`id | integer |
| `sourceId` | External system unique id. `sourceId` should be combined with `source` | string |
| `externalId` (deprecated) | id of an external system which is stored as externalId in the Propellor `order` | string |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Expanding resources

| **Query parameter** | **Description** |
| --- | --- |
| `orderItems` | Expand `orderItems` in the response payload |
| `orderItems`.product | Expand `product` details as part of the `orderItems` in the response payload |
| `sources` | Expand `sources` in the response payload |

## Order Errors

This section describes error codes specific for the `Order` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `15001` | OrderNotFound | 404 | Order does not exist | Order with such lookup key not found |
| `15002` | OrderNotProcessed | 400 | Order not processed | Order was not processed successfully |
| `15003` | ParentOrderNotFound | 404 | Parent order does not exist | Parent order with such lookup key not found. This error is typical when working with order sub-resources (e.g. addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | Order address does not exist |
| `15004` | OrderExists | 400 | Order already exists | When creating / updating an order the `sourceId / source` combination already exists in Propeller. |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Pricesheets

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/pricesheets.tag

<LegacyBanner />



Price sheets are a common and quite familiar concept in the e-commerce world. A price sheet can include the prices for products or groups of products i.e. categories. A single price sheet can be assigned to multiple users. Check the [Users endpoints](/reference/legacy/rest-sonar/users) to learn how to assign a pricesheet to a user.

## Price Sheet Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller pricesheet id, auto-generated |
| `code` | string | Price sheet code |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Price sheet fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `code` | Price sheet code | string  <br />integer |
| `shopId` | Identifies the shop the pricesheet will be valid for | integer |
| `name` | Price sheet name | string |
| `description` | Price sheet description | string |

## Pricing

Pricing for products and categories can be defined for different resources: pricesheet which can be assigned for a user or usergroup, or directly define pricing for user or usergroup.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `categories` | List of categories and corresponding prices | array\[[PricingItem](/reference/legacy/rest-sonar/pricesheets#pricing-item)\] |
| `products` | List of products and corresponding prices | array\[[PricingItem](/reference/legacy/rest-sonar/pricesheets#pricing-item)\] |
| `shopId` | Identifies the shop the prices will be valid for.  <br />For pricesheet prices, `shopId` is inferred from pricesheet's `shopId`. For user type discounts, if not provided, a default one will be set (first shop found). | integer |

## Pricing Item

A pricing item identifies the resource for which the prices are defined. This resource can be a product or a category. The resource can be defined by either `id` or `sourceId` in combination with `source`. The pricing item also includes the price itself.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `id` | [Resource Id](/reference/legacy/rest-sonar/api-reference#lookup-keys) | integer |
| `sourceId` | [Source Id](/reference/legacy/rest-sonar/api-reference#lookup-keys) | string |
| `source` | [Source](/reference/legacy/rest-sonar/api-reference#lookup-keys) | string |
| `pricing` | Price | [PricingElement](/reference/legacy/rest-sonar/pricesheets#pricing-element) |

## Pricing Element

This field represents the actual price definition.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `type` | Price type  <br />  <br />Cost price plus (CP) = The cost price of a product + `amount` percent  <br />Sales price minus (SP) = The sales price of a product - `amount` percent  <br />Net = Net `price` | enum  <br />  <br />CP  <br />SP  <br />net |
| `amount` | Percent. Should be used in combination with `type` SP or CP. | decimal |
| `price` | Net price. Should be used when `type` is net. | decimal |
| `quantity` | The minimum quantity for which this price is valid | integer |
| `validFrom` | The price is valid after this date | date |
| `validTo` | The price is valid before this date | date |

## Pricesheet/ Pricing Errors

This section describes error codes specific for the `Pricesheet` and `Pricing`resources.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `12001` | PricesheetExists | 400 | Pricesheet already exists | Pricesheet with such lookup key already exists |
| `12002` | PricesheetNotFound | 404 | Pricesheet not found | Pricesheet with such lookup key not found |
| `12003` | PricesheetPricingExists | 400 | Pricesheet already contains pricing | Pricesheet/ User/ Usergroup pricing already exists |
| `12004` | PricesheetPricingError | 400 | Error listing pricing | Error retrieveing pricing |
| `12005` | ParentPricesheetsNotFound | 404 | Parent resource pricesheet not found | Parent pricesheet with such lookup key not found. This error is typical when working with pricesheet pricing |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Process order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/process-order-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Process order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/process"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Process an order by a specific lookupKey / lookupId combination.

| **lookupKeys** |
| --- |
| `id` |
| `externalId` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

Processing an order does the following:

1. for each supplier in the order a purchase order and backorder is created
2. the order is set to status CONFIRMED
    

Once an order is processed, [shipments / track and trace codes](/reference/legacy/rest-sonar/orders) can be booked on backorders.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order \n\n`id` - Integer, `externalId` - String"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Process order by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"1948"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:38:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ccfe1260-b39d-45f7-a0f1-5135c1b578b1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"JS"},"company":{"type":"string","example":"Propellor"},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":"julielarue@propellor.eu"},"firstName":{"type":"string","example":"Jullien"},"fullName":{"type":"string","example":"Jullien Serres"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14718},"lastName":{"type":"string","example":"Serres"},"login":{"type":"string","example":"julielarue@propellor.eu"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"06-12345678"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-03-16T15:00:55"},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"id":{"type":"number","example":195},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"w.spies@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81903},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"20"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"siteId":{"type":"number","example":100037},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"11":{"type":"number","example":32.2234},"21":{"type":"number","example":0}}},"totalGross":{"type":"number","example":292.94},"totalNet":{"type":"number","example":325.1634}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14718}}},"messages":{"type":"array","items":{"type":"string","example":"Order processed"},"example":["Order processed"]},"total":{"type":"number","example":1}}},"examples":{"Process order by lookup key - 200":{"value":{"data":{"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-03-16T15:00:55","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":195,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"11":32.2234,"21":0},"totalGross":292.94,"totalNet":325.1634},"type":"dropshipment","userId":14718},"messages":["Order processed"],"total":1}}}}}},"404":{"description":"Order process by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:38:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"54f24187-0fd5-42ad-a456-2f0aa887f653"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [295] not found"},"example":["Order with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Order process by lookup key - 404":{"value":{"error":{"code":15001,"messages":["Order with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Products

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/products.tag

<LegacyBanner />



Products are the sellable goods in an e-commerce shop on the Propeller platform. They are usually organized hierarchically in [categories](/reference/legacy/rest-sonar/categories). The Product API can be used to consult, create, update or delete a Product.

## Product Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller product id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |
| `sku` | string | Product SKU/ code |
| `code` (deprecated) | string | Product code |
| `supplierCode` | string | Product code as known to the product supplier. `supplierCode` should be combined with `supplier` |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `names` | Product name | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `language` | Product default language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent category | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `sku` | Product SKU (code) | string |
| `unit` | The number of packages that need to be ordered when adding an item to the basket | integer |
| `status` | Product status | enum  <br />  <br />**A**\=Available  <br />**N**\=Not available  <br />**T**\=Out of stock  <br />**P**\=Phase out  <br />**S**\=Presale  <br />**R**\=Restricted |
| `price` | Sales price | decimal |
| `costPrice` | Cost price | decimal |
| `suggestedPrice` | Suggested/ advised price | decimal |
| `discountPrice` | Discount price | decimal |
| `discountPriceFrom` | Discount price from date | date |
| `discountPriceTo` | Discount price to date | date |
| `priceDisplay` | Type of price display | enum  <br />  <br />**default** = Only display price  <br />**onrequest** = Do not show price, show "Price on request"  <br />**from** = Show cheapest price  <br />**fromfor** = Show old (suggested) price vs. new price  <br />**perpackage** = price per type of package (e.g. Price from € 125.50 per box)  <br />**peruom** = Cheapest price per package unit (e.g. Price from € 125.50 per piece) |
| `descriptions` | Product description | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `shortName` | Product short name | string |
| `shortDescriptions` | Product short descriptions | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `taxCode` | Product tax code | enum  <br />  <br />**H**\=High  <br />**L**\=Low  <br />**N**\=None |
| `supplier` | Product supplier | string |
| `supplierCode` | Product code as known to the product supplier | string |
| `manufacturer` | Manufacturer | string |
| `oemCode` | Product manufacturer code | string |
| `eanCode` | Product EAN code | string |
| `minimumQuantity` | Minimum orderable quantity | integer |
| `package` | Package (e.g. piece, sheet, etc.) | string |
| `packageDescriptions` | Description of package and  <br />package units inside a  <br />package (e.g. Box of 650 sheets of paper) | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `notes` | Product notes/ remarks | array\[[LocalizedString](/reference/legacy/rest-sonar/api-reference#localized-string)\] |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Product Errors

This section describes error codes specific for the `Product` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `80004` | ProductExists | 400 | Product already exists | Category with such lookup key already exists |
| `80005` | ProductMultipleFound | 400 | Multuple products found. Please provide additional filters | Multiple products with such lookup key exist |
| `80006` | ProductNotFound | 404 | Product does not exist | Product with such lookup key not found |
| `80007` | ParentProductNotFound | 404 | Parent product not found | Parent product with such lookup key not found. This error is typical when working with product sub-resources (e.g. attributes) |
| `80008` | ProductNotAllowed | 405 | Product is not allowed | No permission for the product |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Remove Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/remove-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete cluster config by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"8"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Remove Cluster Config - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"51"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:02:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"57071cd3-b8d9-4112-a08d-3b16e1d28052"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config deleted"},"example":["Cluster Config deleted"]}}},"examples":{"Remove Cluster Config - 200":{"value":{"data":{},"messages":["Cluster Config deleted"]}}}}}},"404":{"description":"Remove Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"175"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:04:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"308b6bfb-2a06-4fc7-903d-b7dec33b6de2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21005},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with id [7] not found"},"example":["Cluster Config with id [7] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigNotFound"}}}}},"examples":{"Remove Cluster Config - 404":{"value":{"error":{"code":21005,"messages":["Cluster Config with id [7] not found"],"moreInfo":"https://www.propel.us/docs/errors/21005","status":404,"type":"ClusterConfigNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Remove Setting from Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/remove-setting-from-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove Setting from Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings/{settingId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"},{"name":"settingId","in":"path","required":true,"schema":{"type":"string","example":"116"},"description":"The id of cluster config setting"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Remove Setting from Cluster Config - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"59"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:01:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"ef96dc84-ebbd-4a4d-92d6-a8bedd2d7652"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config setting deleted"},"example":["Cluster Config setting deleted"]}}},"examples":{"Remove Setting from Cluster Config - 200":{"value":{"data":{},"messages":["Cluster Config setting deleted"]}}}}}},"404":{"description":"Remove Setting from Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"192"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:01:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"131ed70f-1bc1-45a7-88c8-9385c2d484a1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21007},"messages":{"type":"array","items":{"type":"string","example":"Cluster config setting with id [117] not found"},"example":["Cluster config setting with id [117] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigSettingNotFound"}}}}},"examples":{"Remove Setting from Cluster Config - 404":{"value":{"error":{"code":21007,"messages":["Cluster config setting with id [117] not found"],"moreInfo":"https://www.propel.us/docs/errors/21007","status":404,"type":"ClusterConfigSettingNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Rules execute

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/rules-execute.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Rules execute"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/rules/{resource}/execute"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Executes rules for the selected resource.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"shopId","in":"query","schema":{"type":"string","example":"1"},"description":"Provide for `resource` of type `orders`. Otherwise ignored. Defaults to first shop"},{"name":"resource","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Type of rules to execute:\n\norders\nusers\nproducts"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Rules reset

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/rules-reset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Rules reset"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/rules/{resource}/reset"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Propeller keeps track on which entities rules have been executed. Once all rules have been executed on an entity it will be internally marked as 'rules applied' and executing the rules execute endpoint again will not trigger the rules for this entity anymore.

There are two ways of 'resetting' the 'rules applied' value:

1. update the entity (either via the Propeller back office or API)
2. by using the rules reset endpoint.
    

The rules reset endpoint resets the 'rules applied' value for all entities.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"shopId","in":"query","schema":{"type":"string","example":"1"},"description":"Provide for `resource` of type `orders`. Otherwise ignored. Defaults to first shop"},{"name":"resource","in":"path","required":true,"schema":{"type":"string","example":"orders"},"description":"Type of rules to execute:\n\nusers\nproducts"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Rules

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/rules.tag

<LegacyBanner />



The Propeller rules engine allows for fast and easy data formatting and/or structuring. Based on certain conditions, actions on orders, products or users will be executed.



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Search attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/search-attributes.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search attributes"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a list of attributes by using the search fields below:

| **Field** | **Type** |
| --- | --- |
| `ids` | array(int) |
| `names` | array(string) |
| `class` | string |
| `isPublic` | boolean |
| `isSearchable` | boolean |
| `isHidden` | boolean |
| `isSystem` | boolean |
| `offset` | int (max: `100``) |
| `page` | int |

Results will be [paginated](/reference/legacy/rest-sonar/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"array","items":{"type":"number","example":716},"example":[716,717]},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"string","example":"COLOR"},"example":["COLOR","WEIGHT"]},"offset":{"type":"number","example":10},"page":{"type":"number","example":1}}},"examples":{"Search attributes":{"value":{"class":"product","id":[716,717],"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"names":["COLOR","WEIGHT"],"offset":10,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search attributes - 200 (with results) / Search attributes - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"84"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 09:52:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"917f82b7-deb3-4df4-89ad-c49c87011f00"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"defaultLanguage":{"type":"string","example":"EN"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Weight"}}},"example":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":661},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"WEIGHT"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"string","example":""}]}}},"example":[{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}],"group":"","id":661,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}],"value":0},{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""}]},"end":{"type":"number","example":2},"itemsFound":{"type":"number","example":2},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":10},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":2}}},"examples":{"Search attributes - 200 (no results)":{"value":{"data":[],"itemsFound":0,"messages":["Completed"],"offset":10,"page":1,"total":1}},"Search attributes - 200 (with results)":{"value":{"data":[{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}],"group":"","id":661,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}],"value":0},{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""}],"end":2,"itemsFound":2,"messages":["Completed"],"offset":10,"page":1,"pages":1,"start":1,"total":2}}}}}},"400":{"description":"Search attributes - 400 (invalid search fields)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"182"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 09:53:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1132c373-b2a4-4406-96bf-24a0dc1e709e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [id] is not permitted"},"example":["#: extraneous key [id] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search attributes - 400 (invalid search fields)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [id] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/search-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.

### Available search fields

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| `productIds` (array \[integer\]) | Array of product ids. | yes |
| `warehouseId` (integer) | Warehouse id. | no |
| `location` (string) | Location. | no |

Mandatory field in search payload is productIds array. If warehouseId or location are not sent in the payload, inventories will not be filtered by warehouse and/or location.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"offset","in":"query","schema":{"type":"string","example":"15"},"description":"Number of records per page. Default value is 12"},{"name":"page","in":"query","schema":{"type":"string","example":"8"},"description":"Page number. Default value is 1"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","example":""},"productIds":{"type":"array","items":{},"example":[]}}},"examples":{"Search Inventory":{"value":{"location":"","productIds":[]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Inventory - 200 / Search Inventory - 200 (expands inventoryBalance)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"585"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:25:25 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":20},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"productId":{"type":"number","example":37232},"supplierQuantity":{"type":"number","example":0},"supplierReservedQuantity":{"type":"number","example":164},"totalQuantity":{"type":"number","example":20},"totalReservedQuantity":{"type":"number","example":164}}},"example":[{"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0},{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}]},"end":{"type":"number","example":3},"itemsFound":{"type":"number","example":3},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":3}}},"examples":{"Search Inventory - 200":{"value":{"data":[{"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0},{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"end":3,"itemsFound":3,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":3}},"Search Inventory - 200 (expands inventoryBalance)":{"value":{"data":[{"balance":[{"companyId":0,"costPrice":25.5,"dateModified":"2022-06-20T13:40:00","id":1,"location":"","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":37232,"quantity":20,"sku":"","supplier":"","supplierCode":"757540","usergroupId":0,"warehouseId":""},{"companyId":0,"costPrice":0,"dateModified":"2022-08-29T21:27:39","id":16132,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":37232,"quantity":3,"sku":"757540","supplier":"INTERN","supplierCode":"757540","usergroupId":0,"warehouseId":2},{"companyId":0,"costPrice":0,"dateModified":"2022-08-29T21:29:17","id":16138,"location":"","nextDeliveryDate":"","notes":"","productId":37232,"quantity":3,"sku":"757540","supplier":"INTERN","supplierCode":"757540","usergroupId":0,"warehouseId":0}],"localQuantity":26,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":37232,"supplierQuantity":0,"supplierReservedQuantity":0,"totalQuantity":26,"totalReservedQuantity":0},{"balance":[{"companyId":227583,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16139,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":87,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2023-09-28T19:56:35","id":16140,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":16,"sku":"NCABD70004","supplier":"KERRIDGE","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16141,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":227237,"quantity":77,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:12:48","id":16142,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":82,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0}],"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164},{"balance":[{"costPrice":25.5,"dateModified":"2022-06-20T13:40:00","id":1,"location":"","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":37232,"quantity":20,"sku":"","supplier":"","supplierCode":"757540","warehouseId":""}],"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"balance":[],"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0}],"end":3,"itemsFound":3,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":3}}}}}},"400":{"description":"Search Inventory - 400 (empty productIds array)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"197"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:26:31 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/productIds: expected minimum item count: 1, found: 0"},"example":["#/productIds: expected minimum item count: 1, found: 0"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Inventory - 400 (empty productIds array)":{"value":{"error":{"code":10007,"messages":["#/productIds: expected minimum item count: 1, found: 0"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Links

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/search-links.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Links"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/links/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a list of links by using the search fields below:

| **Field** | **Type** |
| --- | --- |
| `type` | string |
| `subtype` | string |
| `from` | JSON object |
| `to` | JSON object |
| `isActive` | boolean |
| `isDefault` | boolean |
| `priority` | int |
| `offset` | int (max: `100`, default: `12`) |
| `page` | int |

Results will be [paginated](/reference/legacy/rest-sonar/api-reference#pagination). The default number of links per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"ids":{"type":"array","items":{"type":"number","example":24603},"example":[24603]}}},"offset":{"type":"number","example":100},"page":{"type":"number","example":1},"prioritye":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"ids":{"type":"array","items":{"type":"number","example":27401},"example":[27401]}}},"type":{"type":"string","example":"accessories"}}},"examples":{"Search Links":{"value":{"from":{"class":"product","ids":[24603]},"offset":100,"page":1,"prioritye":0,"subtype":"Extrasale","to":{"class":"product","ids":[27401]},"type":"accessories"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Links - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"1182"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:08:32 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dateChanged":{"type":"string","example":"2018-11-08T11:35:38"},"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":24603}}},"id":{"type":"number","example":485377},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":false},"priority":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":27401}}},"type":{"type":"string","example":"accessories"}}},"example":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485378,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24235},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485379,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24005},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485380,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24063},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485381,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24035},"type":"accessories"}]},"end":{"type":"number","example":5},"itemsFound":{"type":"number","example":5},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":100},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":5}}},"examples":{"Search Links - 200":{"value":{"data":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485378,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24235},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485379,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24005},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485380,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24063},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485381,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24035},"type":"accessories"}],"end":5,"itemsFound":5,"messages":["Completed"],"offset":100,"page":1,"pages":1,"start":1,"total":5}}}}}},"400":{"description":"Search Links - 400","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"189"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:10:37 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [prioritye] is not permitted"},"example":["#: extraneous key [prioritye] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Links - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [prioritye] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Orders

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/search-orders.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Orders"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve a list of orders by using the search fields below

| **Name** | **Type** | **Required** |
| --- | --- | --- |
| `status` | string | no |
| `exported` | boolean | no |
| `externalOrderNumber` | string | no |
| `dateCreated` | [DateFilter](#date-filter) | no |
| `dateStatusModified` | [DateFilter](#date-filter) | no |

**status:** the value of the status in Propeller. By default the available statuses are:

*   NEW
*   VALIDATED
*   CONFIRMED
*   ARCHIVED
    

It is possible to create custom statuses in Propeller, please consult the Propeller backoffice for custom status values.

**exported:** Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Once an order has been exported it is good practice to mark the order as exported using the `order` update api. Searching for orders using the exported field will return a list of orders which are (or not) exported to an external system.

**externalOrderNumber:** Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Depending on the type of system / techniques used for exporting, Propeller gets back an identifier from these systems (e.g an order id / invoice id). This id is stored in Propellor and can be used for searching using the order search api.
## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"orderItems"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"extraStatus":{"type":"string","example":"CONFIRMED"}}},"examples":{"Search Orders":{"value":{"extraStatus":"CONFIRMED"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Orders - 200  (with results) / Search Orders - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"37"}},"date":{"schema":{"type":"string","example":"Mon, 28 Feb 2022 17:07:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"065d03d1-41e2-42e8-b2a0-82fd3330c106"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"SV"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":"sander123@propel.us"},"firstName":{"type":"string","example":"Sander"},"fullName":{"type":"string","example":"Sander Vleugelhof"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14711},"lastName":{"type":"string","example":"Vleugelhof"},"login":{"type":"string","example":"sander123@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"undefined"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-02-24T14:14:55"},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"id":{"type":"number","example":162},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81752},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":5},"postageNet":{"type":"number","example":6.05},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81753},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"21":{"type":"number","example":3.15}}},"totalGross":{"type":"number","example":20},"totalNet":{"type":"number","example":24.2}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14711}}},"example":[{"channelId":1,"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T03:11:58","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":165,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81765,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81766,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T10:45:20","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":166,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81773,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81774,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":6.3},"totalGross":35,"totalNet":42.35},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T14:56:59","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":167,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81779,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81780,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":5.9073},"totalGross":33.13,"totalNet":40.0873},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T19:04:27","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":169,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81793,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81794,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":23.31},"totalGross":111,"totalNet":134.31},"type":"dropshipment","userId":14718}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":5}}},"examples":{"Search Orders - 200  (with results)":{"value":{"data":[{"channelId":1,"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T03:11:58","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":165,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81765,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81766,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T10:45:20","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":166,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81773,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81774,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":6.3},"totalGross":35,"totalNet":42.35},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T14:56:59","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":167,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81779,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81780,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":5.9073},"totalGross":33.13,"totalNet":40.0873},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T19:04:27","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":169,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81793,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81794,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":23.31},"totalGross":111,"totalNet":134.31},"type":"dropshipment","userId":14718}],"messages":[],"total":5}},"Search Orders - 200 (no results)":{"value":{"data":[],"messages":[],"total":0}}}}}},"400":{"description":"Search Orders - 400 (invalid fieldname)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"317"}},"date":{"schema":{"type":"string","example":"Mon, 28 Feb 2022 17:08:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"426a69e6-4f30-49fa-b10a-1629a9394182"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [extraStatus] is not permitted"},"example":["#: extraneous key [extraStatus] is not permitted","#: required key [exported] not found","#: required key [externalOrderNumber] not found","#: required key [status] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Orders - 400 (invalid fieldname)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [extraStatus] is not permitted","#: required key [exported] not found","#: required key [externalOrderNumber] not found","#: required key [status] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Products

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/search-products.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Products"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The product search endpoint is only available on the Propeller legacy version. The cloud version of Propeller does not support this API. Instead, use the GraphQL APIs to query products. 
  

Retrieves a list of products by using the search fields below. Results will be [paginated](/reference/legacy/rest-sonar/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `term`  <br />Search through any text indexed on a product, like name, descriptions, product codes, keywords, etc. | array\[integer\] |
| `categoryId` | integer |
| `code` | string |
| `oemCode` | string |
| `eanCode` | string |
| `manufacturer` | string |
| `supplierCodes` | array\[string\] |
| `textFilters` | array\[[TextFilter](#product-text-filter)\] |
| `rangeFilers` | array\[[RangeFilter](#product-range-filter)\] |
| `priceFilters` | [PriceFilter](#product-price-filter) |
| `dateCreated` | [DateFilter](#product-date-filter) |
| `dateModified` | date (yyyy-mm-ddThh:nn:ss) |
| `orderBy` | enum  <br />**product_price**\= order by `price`  <br />**product_name** = order by `name`  <br />**product_code** = order by `sku`**product_manufacturer** = order by `brand`  <br />**product_suppliercode** = order by `supplierCode`**product_oemcode** = order by `oemCode`  <br />**directory_order** = order by `dateCreated`  <br />**product_supplier** = order by `supplier`  <br />**container_name** = order by category `name`  <br />**best_sold** = order by number of times sold |
| `orderDirection` | enum  <br />**ASC** = ascending  <br />**DESC** = descending |
| `offset` | integer |
| `page` | integer |

## Product text filter

A text filter is used to search through text product fields and product [attributes](/reference/legacy/rest-sonar/attributes) of type `text`, `list`, `enum` or `enumlist`, in which case `searchId` is the name of the attribute. When searching product fields, `searchId` can be:

- searchproduct_code: `sku`
- searchproduct_name: `name`
- searchproduct_suppliercode: `supplierCode`
- searchcode_supplier: `supplier`
- searchcode_manufacturer:`brand`
- searchproduct_oemcode: `oemCode`
- searchproduct_container_name: `name` of parent category
    

```json
{
    "searchId": "MATERIAL_FRAME",
    "value": "Leer"
}
```
## Product range filter

A range filter is used to search through numeric product [attributes](/reference/legacy/rest-sonar/attributes) i.e. attributes of type `integer` or `decimal`, in which case `searchId` is the name of the attribute.

```json
{
    "searchId": "WEIGHT",
    "from": 65.2,
    "to": 120
}
```
## Product price filter

A price filter is a special price search object that can search through a range:

```json
{
    "from": 150.23,
    "to": 500.25
}
```
## Product date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categoryId":{"type":"number","example":1200},"code":{"type":"string","example":"NCABD70005"},"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2022-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2022-12-12T00:00:00"}}},"eanCode":{"type":"string","example":"0753759256211"},"manufacturer":{"type":"string","example":"Garmin"},"oemCode":{"type":"string","example":"NCABD70005"},"offset":{"type":"number","example":10},"orderBy":{"type":"string","example":"product_price"},"orderDirection":{"type":"string","example":"ASC"},"page":{"type":"number","example":1},"priceFilters":{"type":"object","properties":{"from":{"type":"number","example":150.23},"to":{"type":"number","example":500.25}}},"rangeFilters":{"type":"array","items":{"type":"object","properties":{"from":{"type":"number","example":65.2},"searchId":{"type":"string","example":"WEIGHT"},"to":{"type":"number","example":120}}},"example":[{"from":65.2,"searchId":"WEIGHT","to":120}]},"supplierCodes":{"type":"array","items":{"type":"string","example":"NCABD70005"},"example":["NCABD70005"]},"term":{"type":"string","example":"fietscomputer"},"textFilters":{"type":"array","items":{"type":"object","properties":{"searchId":{"type":"string","example":"MATERIAL_FRAME"},"value":{"type":"string","example":"Leer"}}},"example":[{"searchId":"MATERIAL_FRAME","value":"Leer"}]}}},"examples":{"Search Products":{"value":{"categoryId":1200,"code":"NCABD70005","dateCreated":{"from":"2020-12-12T00:00:00","to":"2022-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2022-12-12T00:00:00"},"eanCode":"0753759256211","manufacturer":"Garmin","oemCode":"NCABD70005","offset":10,"orderBy":"product_price","orderDirection":"ASC","page":1,"priceFilters":{"from":150.23,"to":500.25},"rangeFilters":[{"from":65.2,"searchId":"WEIGHT","to":120}],"supplierCodes":["NCABD70005"],"term":"fietscomputer","textFilters":[{"searchId":"MATERIAL_FRAME","value":"Leer"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Update attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint enables updating the definition of an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"value":{"type":"array","items":{},"example":[]}}},"examples":{"Update attribute by lookup key":{"value":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":[]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update attribute by Id - 200 / Update attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:19:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7e399cb8-ddff-4a1f-a0ef-04edaec18600"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"messages":{"type":"array","items":{"type":"string","example":"Attribute updated"},"example":["Attribute updated"]},"total":{"type":"number","example":1}}},"examples":{"Update attribute by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":""},"messages":["Attribute updated"],"total":1}},"Update attribute by name and class - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":""},"messages":["Attribute updated"],"total":1}}}}}},"400":{"description":"Update attribute by name and class - 400 (invalid value)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"188"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:21:13 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6863900a-d410-4a30-a829-05e448ded69c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14005},"messages":{"type":"array","items":{"type":"string","example":"Invalid value provided. Attribute type is [enum]."},"example":["Invalid value provided. Attribute type is [enum]."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"AttributeInvalidValue"}}}}},"examples":{"Update attribute by name and class - 400 (invalid value)":{"value":{"error":{"code":14005,"messages":["Invalid value provided. Attribute type is [enum]."],"moreInfo":"https://www.propel.us/docs/errors/14005","status":400,"type":"AttributeInvalidValue"}}}}}}},"404":{"description":"Update attribute by Id - 404 / Update attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"203"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:20:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7dd29b63-5541-460b-9826-fadae75be9be"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [800] not found."},"example":["Attribute with id [800] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Update attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [800] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Update attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [COLOR] and attributeClass [category] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"examples":{"Update Category by lookup key":{"value":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"350"}},"date":{"schema":{"type":"string","example":"Wed, 30 Mar 2022 12:49:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"27bfbfa7-8497-4486-92c3-8c0aa9ebb958"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1771},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"messages":{"type":"array","items":{"type":"string","example":"Category updated"},"example":["Category updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Category by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1771,"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"},"messages":["Category updated"],"total":1}}}}}},"404":{"description":"Update Category by source id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Wed, 30 Mar 2022 12:50:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"203f32e5-5475-4605-b89d-cacd6f366d32"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [17712] not found"},"example":["Category with sourceId [17712] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Update Category by source id - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [17712] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a single cluster.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `parent` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `clusterConfigId` | no |
| `code` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"151203000"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203000"}}},"examples":{"Update Cluster by lookup key":{"value":{"clusterConfigId":11,"code":"151203000","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}],"names":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"parent":{"id":23409},"shortDescriptions":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"source":"REST-API","sourceId":"151203000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Cluster by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"760"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:41:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bf84a8e8-8aea-4192-99b9-65fffca284ff"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"151203000"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}]},"id":{"type":"number","example":210},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster updated"},"example":["Cluster updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Cluster by lookup key - 200":{"value":{"data":{"clusterConfigId":11,"code":"151203000","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}],"id":210,"names":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"parent":{"id":23409},"shortDescriptions":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"source":"REST-API","sourceId":"151203000"},"messages":["Cluster updated"],"total":1}}}}}},"404":{"description":"Update Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"164"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:41:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"91909ffd-bd9d-47b5-a243-bad30af291a9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [211] not found"},"example":["Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Update Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Cluster Config Setting

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-cluster-config-setting.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Cluster Config Setting"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings/{settingId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `displayType` | no |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"},{"name":"settingId","in":"path","required":true,"schema":{"type":"string","example":"116"},"description":"The id of cluster config setting"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"displayType":{"type":"string","example":"radio"}}},"examples":{"Update Cluster Config Setting":{"value":{"displayType":"radio"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Cluster Config Setting - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"99"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:59:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a73fa162-0f96-41c0-bb43-2bb3eb744100"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"displayType":{"type":"string","example":"radio"},"id":{"type":"number","example":116}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config Setting updated"},"example":["Cluster Config Setting updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Cluster Config Setting - 200":{"value":{"data":{"displayType":"radio","id":116},"messages":["Cluster Config Setting updated"],"total":1}}}}}},"404":{"description":"Update Cluster Config Setting - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:00:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"0aa2856c-2fd5-4a52-8444-c532e5ba8ecf"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21007},"messages":{"type":"array","items":{"type":"string","example":"Cluster config setting with id [117] not found"},"example":["Cluster config setting with id [117] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigSettingNotFound"}}}}},"examples":{"Update Cluster Config Setting - 404":{"value":{"error":{"code":21007,"messages":["Cluster config setting with id [117] not found"],"moreInfo":"https://www.propel.us/docs/errors/21007","status":404,"type":"ClusterConfigSettingNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint enables updating inventory record by it's unique id.

### Available update fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `costPrice` (integer) | no |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

`warehouseId` and `location` cannot be updated.

If product stock is moved to a different warehouse or location, old inventory record should be updated with 0 quantity, then create a new record with the new warehouseId and/or location

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":25.5},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":20}}},"examples":{"Update Inventory by Id":{"value":{"costPrice":25.5,"nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":20}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Inventory by Id - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"339"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 19:33:14 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":25.5},"dateModified":{"type":"string","example":"2023-10-02T19:33:14"},"id":{"type":"number","example":16141},"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":227237},"quantity":{"type":"number","example":20},"sku":{"type":"string","example":"NCABD70004"},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"usergroupId":{"type":"number","example":143},"warehouseId":{"type":"number","example":0}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Inventory by Id - 200":{"value":{"data":{"companyId":0,"costPrice":25.5,"dateModified":"2023-10-02T19:33:14","id":16141,"location":"B45","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":20,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"378"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 15:31:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e0322069-5ccc-4942-94a3-51f1477fa9c4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Update Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a link by Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"priority1":{"type":"number","example":1}}},"examples":{"Update Link by Id":{"value":{"isActive":true,"isDefault":true,"priority1":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Link by Id 202","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"96"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:58:41 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"priority":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Link updated"},"example":["Link updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Link by Id 202":{"value":{"data":{"isActive":true,"isDefault":true,"priority":1},"messages":["Link updated"],"total":1}}}}}},"400":{"description":"Update Link by Id - 400 (invalid schema)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"189"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:59:21 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [priority1] is not permitted"},"example":["#: extraneous key [priority1] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Link by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [priority1] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:58:59 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [731085] not found"},"example":["Link with id [731085] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Update Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [731085] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"examples":{"Update Option by Cluster lookup key and Option Id":{"value":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"276"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:41:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3fef8739-98a1-494e-9ab0-4b426d518c82"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"id":{"type":"number","example":214},"isRequired":{"type":"string","example":"N"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option updated"},"example":["Cluster Option updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Option by Cluster lookup key and Option Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"id":214,"isRequired":"N","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},"messages":["Cluster Option updated"],"total":1}}}}}},"404":{"description":"Update Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:41:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f10955ac-b7aa-4dda-a09e-ec30174ef4da"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [216] not found for the cluster with id [213]"},"example":["Cluster Option with id [216] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Update Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [216] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Order Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-order-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Order Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update an order address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81902"},"description":"Address Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"postalCode":{"type":"string","example":"7323 KE"}}},"examples":{"Update Order Address":{"value":{"postalCode":"7323 KE"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Order Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"90"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:28:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7eed9828-53e0-4a69-9d32-301874cdc022"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":81902},"postalCode":{"type":"string","example":"7323 KE"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Order Address - 200":{"value":{"data":{"id":81902,"postalCode":"7323 KE"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Order Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:30:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d524d2ed-1e19-4ac3-a033-4417e0382d05"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [postalCodes] is not permitted"},"example":["#: extraneous key [postalCodes] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Order Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [postalCodes] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Order Address - 404 (order not found) / Update Order Address - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:32:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ea4c8715-cbc3-46c9-bdc8-22db40ebe4ad"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Update Order Address - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819021] not found for [Orders] with id [195]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Update Order Address - 404 (order not found)":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":0.99},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Update Product by Cluster lookup key and Product Id":{"value":{"costPrice":0.99,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"959"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:32:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a3453129-9e07-4719-bf59-54d0f736fc0d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":0.99},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product updated"},"example":["Cluster Product updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product by Cluster lookup key and Product Id - 200":{"value":{"data":{"costPrice":0.99,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","id":707966,"manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1},"messages":["Cluster Product updated"],"total":1}}}}}},"404":{"description":"Update Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:33:10 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"fb7cb47a-19b8-4ddd-9610-208d4e363be3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707968] not found for the cluster with id [210]"},"example":["Cluster Product with id [707968] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Update Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707968] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Update Product by lookup key":{"value":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2842"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:44:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5706c871-1334-4255-8b48-b3c7bedf4b11"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Product updated"},"example":["Product updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product by Id - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},"messages":["Product updated"],"total":1}}}}}},"400":{"description":"Update Product by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:45:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f0b68a32-00b9-42ac-9c7e-bccbf48fef35"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Product by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Product by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"167"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:46:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fdad0066-9b0d-4ea6-b84b-2e681cbfe8e9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [481189] not found"},"example":["Product with id [481189] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [481189] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product Local Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-product-local-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product Local Inventory"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupkey}/{key}/inventory/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows updating local inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

Inventory will be updated if record is found, matching on: **product sku**, **warehouseId** and **location.** Error is thrown if record can't be found.

Fields w**arehouseId** and **location** can't be updated, used only to find the correct inventory record.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":3},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Update Product Local Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","quantity":3,"usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product Local Inventory - 200 / Update Product Local Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"332"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 16:05:26 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T10:46:50"},"id":{"type":"number","example":16162},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":3},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product Local Inventory - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T10:46:50","id":16162,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory updated"],"total":1}},"Update Product Local Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T16:05:26","id":16148,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":227235,"quantity":3,"sku":"9789006953374","supplier":"INTERN","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Product Local Inventory - 404 / Update Product Local Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 10:48:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0d50b38a-3911-4141-8ecc-06cabbdb216f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product Local Inventory - 404":{"value":{"error":{"code":13006,"messages":["Inventory record not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product Supplier Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-product-supplier-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product Supplier Inventory"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupkey}/{key}/inventory/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows updating supplier inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `supplier` (string) | no  <br />Default value is product supplier |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-sonar/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

Inventory will be updated if record is found, matching on: **product supplierCode**, **supplier, warehouseId** and **location.** Error is thrown if record can't be found.

Fields **supplier**, w**arehouseId** and **location** can't be updated, used only to find the correct inventory record.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":3},"supplier":{"type":"string","example":"KERRIDGE"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Update Product Supplier Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","quantity":3,"supplier":"KERRIDGE","usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product Supplier Inventory - 200 / Update Product Supplier Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"334"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 16:07:01 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T10:49:07"},"id":{"type":"number","example":16152},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":3},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"KERRIDGE"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product Supplier Inventory - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T10:49:07","id":16152,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory updated"],"total":1}},"Update Product Supplier Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T16:07:01","id":16146,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":227235,"quantity":3,"sku":"9789006953374","supplier":"KERRIDGE","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Product Supplier Inventory - 404 / Update Product Supplier Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 10:50:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"36e60fe2-7c1e-45d0-afce-7cd9cb774de3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product Supplier Inventory - 404":{"value":{"error":{"code":13006,"messages":["Inventory record not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update User Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a user address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstNames":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Update User Address":{"value":{"firstNames":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"103"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 19:12:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"820885e1-1675-4bf5-a07b-f418962b891d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":81908},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update User Address by Id - 200":{"value":{"data":{"firstName":"Miles","id":81908,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update User Address by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"190"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6c032004-3b98-412d-b4ae-bd732ffb4748"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [firstNames] is not permitted"},"example":["#: extraneous key [firstNames] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update User Address by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [firstNames] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update User Address by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Update User Address by Id - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update user by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Update User by lookup key":{"value":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update User by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"322"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:35:38 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9da109f0-cf0f-488c-a33f-0394aa0ea289"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14760},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"User updated"},"example":["User updated"]},"total":{"type":"number","example":1}}},"examples":{"Update User by Id - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":14760,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["User updated"],"total":1}}}}}},"400":{"description":"Update User by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:36:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d3892a5c-aa92-44de-8c5f-a972a1ca734e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Update User by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Update User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"162"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:36:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"39d5e568-9da4-48b0-8c75-6639d95c1a70"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with id [1476036] not found"},"example":["User with id [1476036] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Update User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with id [1476036] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Usergroup Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-usergroup-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Usergroup Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a usergroup address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstNames":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Update Usergroup Address":{"value":{"firstNames":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Usergroup Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"103"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 19:12:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"820885e1-1675-4bf5-a07b-f418962b891d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":81918},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Usergroup Address by Id - 200":{"value":{"data":{"firstName":"Miles","id":81918,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Usergroup Address by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"190"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6c032004-3b98-412d-b4ae-bd732ffb4748"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [firstNames] is not permitted"},"example":["#: extraneous key [firstNames] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Usergroup Address by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [firstNames] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Usergroup Address by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Update Usergroup Address by Id - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/update-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update usergroup by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"examples":{"Update Usergroup by lookup key":{"value":{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Usergroup by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"264"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:25:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"21ad3351-2544-4e19-aef2-f01cc4a8e717"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup updated"},"example":["Usergroup updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Usergroup by Id - 200":{"value":{"data":{"budget":"N","budgetInherit":"N","company":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}},"messages":["Usergroup updated"],"total":1}}}}}},"400":{"description":"Update Usergroup by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:24:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"43fe9d1b-48cf-4880-b5b7-e92423f3deb6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Update Usergroup by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Update Usergroup byid - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:26:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b9a1f56f-f834-48fb-92ec-15385c2bee0b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21317] not found"},"example":["Usergroup with id [21317] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Update Usergroup byid - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21317] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Usergroups

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/usergroups.tag

<LegacyBanner />



Usergroups are used to group users or other usergroups together. This parent - child relationship i.e. tree organizational structure is very powerful because it allows inheriting settings, permissions, pricing, etc. A usergroup can even represent a company in a B2B environment, although this concept will soon be deprecated and a dedicated `Companies` resource will be introduced.

## Usergroup Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `usergroup` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | Usergroup name | string |
| `language` | Default system language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `company` | Company | string |
| `department` | Department | string |
| `office` | Office | string |
| `notes` | Notes | string |
| `inheritProductList` | Indicates whether pricing should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `inheritOrderList` | Indicates whether the order list should be inherited from the parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `budget` | Usergroup budget settings | enum  <br />  <br />`Y` = Users in usergroup use budget and may only order products within budget  <br />  <br />`H` = Users in usergroup use budget and may also order products outside budget  <br />  <br />`N` = Users in usergroup do not use budgets |
| `budgetInherit` | Indicates whether budget settings should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `orderListAllowAll` | Order list settings | enum  <br />  <br />`N` = Order everything within the order list  <br />`Y` = Order everything outside the order list  <br />`A` = Order everything, but products outside the order list must be authorized  <br />`U` = Order everything  <br />`P` = Order restricted products |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Usergroup Errors

This section describes error codes specific for the `Usergroup` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `20004` | UsergroupExists | 400 | Usergroup already exists | Usergroup with such lookup key already exists |
| `20005` | UsergroupMultipleFound | 400 | Multuple usergroups found. Please provide additional filters | Multiple usergroups with such lookup key exist |
| `20006` | UsergroupNotFound | 404 | Usergroup does not exist | Usergroup with such lookup key not found |
| `20007` | ParentUsergroupNotFound | 404 | Parent usergroup not found | Parent usergroup with such lookup key not found. This error is typical when working with usergroup sub-resources (e.g. attributes, addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | Usergroup address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Users

URL: https://docs.propeller-commerce.com/reference/legacy/rest-sonar/users.tag

<LegacyBanner />



Users represent data about a specific customer. Carts, orders, attributes, addresses are associated with users.

In a B2C environment a user is the actual customer ordering products, in a B2B environment a user is often part of a `usergroup` representing the organisation he/she is working for. Orders in a B2B environment are still placed by a specific user but connected to the organisation by a single `debtorId`which is associated with the user.

## User Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `user` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-sonar/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `debtorId` | A unique id representing this user. A debtorId can be automatically generated by Propellor | integer  <br />string  <br /> |
| `firstName` | User first name | string |
| `middleName` | User middle name | string |
| `lastName` | User last name | string |
| `fullName` | User full name | string |
| `title` | User title | string |
| `dateOfBirth` | User date of birth | date |
| `gender` | User gender | enum  <br />  <br />**m**\=Male  <br />**f**\=Female  <br />**u**\=Undefined |
| `login` | Login name used to login to the webshop | string |
| `phone` | User phone number | integer |
| `email` | A valid email address | string |
| `company` | Organization the user is working for | string |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with source |
| `pricelistAmount` | A `pricesheet` code in case of special pricing agreements | string |
| `pricelistPercentage` | A `pricesheet` code in case of special pricing agreements | string |
| `taxNumber` | The VAT number of the financial entity this user is part of | `string` |
| `cocNumber` | The chamber of commerce number of the financial entity this user is part of | string |
| `primaryLanguage` | User primary language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## User Errors

This section describes error codes specific for the `User` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `70004` | UserExists | 400 | User already exists | User with such lookup key already exists |
| `70005` | UserMultipleFound | 400 | Multuple users found. Please provide additional filters | Multiple users with such lookup key exist |
| `70006` | UserNotFound | 404 | User does not exist | User with such lookup key not found |
| `70007` | ParentUserNotFound | 404 | Parent user not found | Parent user with such lookup key not found. This error is typical when working with user sub-resources (e.g. attributes, addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | User address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Add Setting to Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/add-setting-to-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Add Setting to Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `attributeName` | yes |
| `displayType` | yes |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_SIZE111"},"displayType":{"type":"string","example":"dropdown"},"priority":{"type":"number","example":2}}},"examples":{"Add Setting to Cluster Config":{"value":{"attributeName":"PROPELLER_SIZE111","displayType":"dropdown","priority":2}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Add Setting to Cluster Config - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"169"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:56:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"916787ee-871a-4792-b7fd-2fd909098684"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_SIZE"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"dropdown"},"id":{"type":"number","example":116},"priority":{"type":"number","example":2}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config Setting created"},"example":["Cluster Config Setting created"]},"total":{"type":"number","example":1}}},"examples":{"Add Setting to Cluster Config - 201":{"value":{"data":{"attributeName":"PROPELLER_SIZE","clusterConfigId":11,"displayType":"dropdown","id":116,"priority":2},"messages":["Cluster Config Setting created"],"total":1}}}}}},"404":{"description":"Add Setting to Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"214"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:56:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"74e2a5e4-55fa-4b46-abeb-aeaab16d5576"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."},"example":["Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Add Setting to Cluster Config - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## API Reference

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/api-reference.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 1.0.0"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"API Reference"}
>
</Heading>



The Propeller REST API is based on resource-oriented URL's, returns JSON-encoded responses and uses standard HTTP response codes, authentication and HTTP methods. The main goal of the REST API is efficiently importing/exporting large amounts of data in/out of the Propeller platform.

## HTTP methods

Propeller REST API supports POST, GET, PATCH, and DELETE HTTP methods.

## Authentication

The REST API uses the [oAuth 2.0 client credentials grant type](https://oauth.net/2/grant-types/client-credentials/) for authentication, every API requests needs a valid access token.

## Request an access token

1. Request an access token by executing [a POST request](/reference/legacy/rest-v1/get-access-token)  to the [token endpoint](https://api.helice.cloud/oauth2/token).  This POST request should include the Client Id and Client Secret.
2. A successful access token request will return the following result:
    

```json
{
  "refresh_token_expires_in": "0",
  "api_product_list": "[Propeller REST APIs]",
  "api_product_list_json": [
    "Propeller REST APIs"
  ],
  "organization_name": "propeller-platform-prod",
  "developer.email": "developer@propel.us",
  "token_type": "BearerToken",
  "issued_at": "1646873717224",
  "client_id": "veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT",
  "access_token": "ARAo4GjuI1bGSyenSKx5oYfFGuFQ",
  "application_name": "a1ca275a-2abb-4bd3-82b0-3ae699d75e40",
  "scope": "",
  "expires_in": "1899",
  "refresh_count": "0",
  "status": "approved"
}
```
3. Parse the `access_token` value from this result and use it as a [bearer token](https://oauth.net/2/bearer-tokens/) in subsequent API requests.

4. After 30 minutes the requested `access_token` expires and a new token needs to be requested.

## Lookup keys

The REST API offers multiple ways to identify resources. In Propeller terminology these are called lookup keys. For example: a product can be identified by its Propellor internal `id`but also by an `sku.` A `sku` however, is not guaranteed to be unique in the catalogue, as multiple `products` with the same `sku` can exist. If multiple resources are found based on the lookup key / value combination the result of the request will be an error. In case of multiple `products` with the same `sku` a GET or PATCH request to this product will result in an error.

| **Lookup Key** | **Description** |
| --- | --- |
| `id` | Unique Propeller id of an object |
| `externalId` | Unique external id |
| `sourceId/source` | External system unique id to a Propeller resource. `sourceId` always needs to be combined with a `source`. Source is typically the name of a supplier or ERP system the data originates from. |
| `sku` | Stock-keeping unit code referencing a product |
| `supplierCode/supplier` | Code of a supplier referencing a product |
| `code` | Code referencing any other resource (e.g. a pricesheet) |

Source Id/ Source lookup key is most commonly used in [Bulk endpoints](/reference/legacy/rest-v1/api-reference#bulk-endpoints). If you're creating/ updating products from an external system, the name of that system would typically be the `source` and `sourceId` would be the product's id or code in that system. This id should be unique in that system and the combination source/sourceId is unique in Propeller. When using the GET, DELETE, UPDATE endpoints with lookup key `sourceId` you can use it without `source`, but if multiple resources are found you will get an error. In that case use `source` as well.

Supplier code / supplier is another common way of looking up products. The difference between the sourceId is that the combination does not have to be unique. When it's not and you try to use the GET, UPDATE, DELETE endpoints you will get an error that multiple resources have been found.

## Expanding resources

Some resources allow to request additional information as an expanded resource by using the `expands` request parameter. This parameter is available on all GET REST API requests and applies to the response of that request only.

In many cases, an object contains a related object in its response properties. For example, an `Orderitem` may have an associated `Product` id. Those objects can be expanded inline with the `expands` request parameter.

| **Expand parameter** | **Description** |
| --- | --- |
| `orderItems` | expands the `order` resource with `orderItems` |
| `orderItems.product` | expands the `orderItems` resource with the `product` resource |
| `translation` | expands translated fields for all available languages. |
| `inventoryBalance` | expands all inventory resources for a `product` |
| `defaultProduct` | expand the `cluster` or `option` resource with the default `product` resource |

## Pagination

Querying resources and especially retrieving a lot of data can be potentially really expensive. Therefor, endpoints that retrieve a lot of results are paginated. Use `page` and `offset` query parameters to request a certain page of the result in GET endpoints. When using search endpoints (POST HTTP method), `page` and `offset` are part of the payload.

### Page

You can request a certain page of the result using the `page` query/ payload parameter.

### Offset

You can set the maximum number of results to return using the `offset` query/ payload parameter. The minimum value is `1` and the maximum can differ per API. This is specified in more details in endpoints that support pagination. The default `offset` on most endpoints is `12`.

### Response

This response retrieves 2 results in the data, the number of results per page is 2 and page requested is 1. `total` is the number of records for the page requested, while `itemsFound` is the total number of results.

```json
{
  "data": [
    {
      id: 56897
    },
    {
      id: 36975
    }
  ],
  "messages": [
    "Completed"
  ],
  "start": 1,
  "pages": 20,
  "total": 2,
  "offset": 2,
  "itemsFound": 35,
  "end": 2,
  "page": 1
}
```
## Errors

This section describes error codes used in the Propeller platform REST APIs and their meaning. For details about the API-specific error-codes, consult the documentation dedicated to that API.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `10005` | InvalidJSONPayload | 400 | Invalid JSON Payload | JSON provided in payload is not valid |
| `10006` | InvalidLookupKey | 400 | Invalid lookup key | Lookup key is not supported in the specific API. Check API specific lookup keys |
| `10007` | SchemaValidationException | 400 | Schema Validation Error | JSON schema validation. Response contains the details of the issue |
| `10008` | NotFound | 404 | Resource not found | Resource deleted, non-existing or insufficient permissions |
| `10015` | PaginatedResponseException | 400 | Pagination not properly initialized | `offset` or `page` are not initialized properly. These should be positive integers. Possible maximum limit exceeded on `offset` |
| `10016` | LookupKeyNotFound | 400 | Lookup key not found in payload | Bulk endpoints by a certain lookup key require that the lookup key is provided in the payload |
| `10017` | PayloadValidationError | 400 | Payload validation error | Server side validation of the payload. Response contains the details of the issue |
| `10018` | TranslationNotFound | 404 | Translation not found | Resource deleted, non-existing or insufficient permissions |
| `10019` | WarehouseNotFound | 404 | Warehouse not found | Resource deleted, non-existing or insufficient permissions |
| `10020` | WarehouseInvalidConfiguration | 400 | Warehouse invalid configuration | Warehouse not properly configured, e.g. not a pick up location |

### Error Response

When an API call results in an error, the response contains the `error` property which is an object with the following properties:

| **Property** | **Type** | **Description** |
| --- | --- | --- |
| `code` | string | Error code. Generic error codes are listed [here](/reference/legacy/rest-v1/api-reference#errors), while API specific error codes are listed in each API |
| `status` | integer | Status code |
| `type` | string | Error type. Generic error types are listed [here](/reference/legacy/rest-v1/api-reference#errors), while API specific error types are listed in each API |
| `messages` | array\[string\] | An array of error messages |
| `moreInfo` | string | URL to a page containing details about the error (under construction) |

Example error response:

```json
{
  "error": {
    "code": 80006,
    "status": 404,
    "type": "ProductNotFound",
    "messages": [
      "Product with id [481189] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006"
  }
}
```
## Localized String

A localized string is a JSON object used for fields that are translatable. A localized string has two properties: to indicate the language as per [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) and the value of the translated field in that language.

```json
{
    "language": "EN",
    "value": ""
}
```
## Bulk endpoints

Bulk endpoints allow for an efficient way of importing/updating large amounts of data with just a single API call. Traditional REST API functionality would allow for a single resource (e.g. a `product` or `user`) to be created and a second API request to update this resource. Creating and/or updating multiple resources would mean executing multiple API requests. Working with larger number of resources means this approach would generate a significant number of API calls resulting in inefficient use of resources and import processes taking a lot of time.

The Propeller REST API offers "bulk" functionality to efficiently import/update resources. A bulk request typically contains a payload of multiple resources of a single type (e.g. [product](/reference/legacy/rest-v1/products), [user](/reference/legacy/rest-v1/users), [category](/reference/legacy/rest-v1/categories) or [inventory](/reference/legacy/rest-v1/inventory)). Based on the [lookupKey](/reference/legacy/rest-v1/api-reference#lookup-keys) Propeller will decide if a resource needs to be created or updated.

Bulk endpoints take away the need for multiple API calls to determine if a resource needs to be created or updated and allow for creating/updating multiple resources in on API request.

## Directives

Directives are a powerful Propeller REST APIs concept only used in bulk endpoints. Use directives for actions that are otherwise only doable via a lot of single endpoint API requests. Directives concept is easiest to understand via use cases.

- Let's assume a large number of products is being created/ updated using the Product Bulk endpoint and Propeller's back office is used to maintain some of the data, e.g. product names. When products are created via the bulk endpoint they should not be created with an empty product name. That name can later be changed and we don't want to overwrite it. If it were a single resource endpoint, the GET endpoint could be used to check if the product exists, find the name, compare it, etc. That is not really efficient on a large scale. This is where `skipIfNotEmpty` directive comes handy. Use this directive when you only want to set a field with the value from the payload if it's current value is an empty string.
- Another use case is using Propeller to move resources in a different parent container that the one they were originally created in. Let's assume you have a list of products that belong in certain categories and those products are created via the Bulk endpoints. If you decide to maintain the catalogue structure from within Propeller you would typically move products around manually or via Propeller's rule engine. To avoid a Bulk endpoint would move them back to their original endpoint, use the `skipMoveOnUpdate` directive.
- When creating categories/ product translations you typically have a list of all the active translations you want the resource to be translated in. When using a single resource endpoint you can delete translations one by one, but in the Bulk endpoints use `mergeTranslationsOnUpdate` to reset i.e. delete the ones that are not in the payload.
    

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing resource that are not empty | array of field names, API specific  <br />e.g. for `products` : `names`, `descriptions`, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing resource in the parent resource provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a resource that are not provided in the payload | empty array |
| `skipCreate` | Skip creating new, only update existing resources | empty array |

## Use Cases

## Usergroups - users bulk import

The user rest api is typically used in a B2B environment where a predefined set of customers is allowed access to a webshop / portal. Typically those customers are managed in an ERP and/or CRM system and in order for these customers to have access to the webshop, they need to have an account in Propeller meaning these customers need to be imported into Propeller.

A common way for an ERP/CRM system to handle the concept of customers is to have an entity called customer/debtor or relation and within this entity there are one or multiple contacts. The customer/debtor in this case is a company/organization and has a unique `debtorId` . The contacts are typically persons within the organization with each their own e-mail address/telephone number and multiple different invoice, delivery and visiting addresses.

A typical way to get the ERP / CRM customers into Propeller is to create a Propeller [usergroup](/reference/legacy/rest-v1/usergroups) for each customer and within this `usergroup`, for each contact, a Propeller `user` .

Most of the time the number of customers/contacts which need to be imported will be multiple thousands (if not more). In these cases it is important to use the user and usergroup bulk endpoints, these make sure creating/updating the usergroups / users / addresses / attributes is done in efficiently.

To create the `usergroups` and `users` in Propellor two different bulk endpoints need to be used:

1. the [usergroup bulk endpoint](/reference/legacy/rest-v1/bulk-usergroups-by-id)
2. the [user bulk endpoint](/reference/legacy/rest-v1/bulk-users-by-id)
    

Via the usergroup bulk endpoint multiple usergroups representing companies will be created:

```json
{
    "usergroups": [
        {
           "sourceId": "x-123",
           "source": "MBC",
           "language": "EN",
           "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company X"
        },
        {
            "sourceId": "y-456",
            "source": "MBC",
            "language": "EN",
            "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company Y"
         },
        {
            "sourceId": "z-789",
            "source": "MBC",
            "language": "EN",
            "parent": {
                "sourceId": 999112000
                "source": "MBC"
            },
            "name": "Company Z"
        }
    ]
}
```
The above usergroup bulk endpoint will create or update three usergroups. In this case we use the sourceId / source combination as [lookupKey / lookupValue](#lookup-keys) combination. When using the sourceId / source combination as lookup key, it's possible to identify resources in Propeller based on keys / identifiers from the ERP / CRM system. In the usergroup example, the `source` of the data is Microsoft Business Central (MBC) and the `sourceId` is a unique id / code for a certain customer / organization in Microsoft business central. The combination of the `source` and `sourceId` field will make sure there is only one resource found when referencing a usergroup based on these lookup values.

In advanced setup's its possible to import resources (e.g. customers / contacts) from multiple sources, If usergroups / users would also be imported from a second ERP / CMS system there is a change the `sourceId` would not be available anymore since it is used already by the first import. Because Propeller uses the combination of `sourceId` / `source` to uniquely identify a resource it is possible to import data from multiple different sources using the same sourceId's. A second usergroup import from e.g. Exact Globe could look like this:

```json
{
    "usergroups": [
        {
           "sourceId": "x-123",
           "source": "EXACTGLOBE",
           "language": "EN",
           "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company XX"
        },
        {
            "sourceId": "y-456",
            "source": "EXACTGLOBE",
            "language": "EN",
            "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company YY"
         },
        {
            "sourceId": "z-789",
            "source": "EXACTGLOBE",
            "language": "EN",
            "parent": {
                "sourceId": "999112000"
                "source": "EXACTGLOBE"
            },
            "name": "Company ZZ"
        }
    ]
}
```
In this case the sourceId's from MBC and Exact Globe are the same but because Propeller uses the additional field `source` to identify a resource it is possible to keep using the identifiers generated by the ERP / CRM.

Once the `usergroups` are created the users can be created via the [user bulk endpoint](/reference/legacy/rest-v1/users). To make sure a `user` is created inside the correct `usergroup` within the `user` resource a parent object is added pointing to the `usergroup` using the `source` / `sourceId` of the `usergroup`

```json
{
    "users": [
        {
            "source": "MBC",
            "sourceId": "3002196",
            "language": "NL",
            "parent": {
                "sourceId": "x-123",
                "source" : "MBC"
            },
            "firstName": "Miles",
            "middleName": "",
            "lastName": "McCoy",
            "debtorId": 12345,
            "login" : "miles@xx.com"
            "company" : "Company X"
            "email": "miles@xx.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Mr.",
            "gender": "M"
        },
        {
            "source": "MBC",
            "sourceId": "3002197",
            "language": "NL",
            "parent": {
                "sourceId": "x-123",
                "source" : "MBC"
            },
            "firstName": "Bernie",
            "middleName": "",
            "lastName": "Sawer",
            "debtorId": 12345,
            "login" : "bernie@xx.com"
            "company": "Company X",
            "email": "bernie@xx.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Mr.",
            "gender": "M"
        },
        {
            "source": "MBC",
            "sourceId": "3002200",
            "language": "NL",
            "parent": {
                "sourceId": "x-456",
                "source" : "MBC"
            },
            "firstName": "Delia",
            "middleName": "Ferdi",
            "lastName": "Finney",
            "debtorId": 67890,
            "login" : "Delia@yy.com"
            "company": "Company Y",
            "email": "bernie@yy.com",
            "mobile": "001445888",
            "phone": "001445888",
            "title": "Ms.",
            "gender": "F"
        }
    ]
}
```
A user / usergroup import is something which needs to be executed frequently since changes in the ERP / CRM should be made available in Propeller, new customers need to get access to the webshop and in certain situations access to the webshop needs to be revoked. Using the [bulk endpoints](/reference/legacy/rest-v1/api-reference#bulk-endpoints), the payload only needs to be defined once without any logic.

## Order export

Order searching is typically used in combination with exporting orders to ERP/financial/other external systems. Within the Propeller order workflow there will be the need to export orders at a certain point. Most of the times the need to export an order is when the order transitions to a certain status (e.g. CONFIRMED). Via the order search api it is possible to retrieve a list of orders which are in status CONFIRMED and have not been exported yet (using the fields below)

```json
{
    "status": "CONFIRMED",
    "exported": false    
}
```
Once the orders have been exported it is good practice to update the order and mark it as "exported" field using the order update api. Searching for orders with the above payload will then only result in an list of orders without the previously exported orders.

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"HTTP: Basic Auth"}
      value={"basicAuth"}
    >
      
      
      
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                http
              </td>
            </tr><tr>
              <th>
                HTTP Authorization Scheme:
              </th><td>
                basic
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem><TabItem
      label={"HTTP: Bearer Auth"}
      value={"bearerAuth"}
    >
      
      
      
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                http
              </td>
            </tr><tr>
              <th>
                HTTP Authorization Scheme:
              </th><td>
                bearer
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem><TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div>

---

## Attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/attributes.tag

<LegacyBanner />



Attributes are resources custom defined fields which can be created manually via the Propeller Backoffice or imported via the REST API. Attributes are a powerful and flexible mechanism which are usually used to define products' specification. Another use case is when Propeller's resource pre defined properties are simply not sufficient. Attribute resource values can be inherited from their parent resource. For example, if a product attribute is set on a category, that attribute will be inherited on all products under that category, unless the attribute is set on the product itself.

## Attribute Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller attribute id, auto-generated |
| `name` | string | the name of the attribute. Attribute name can contain any alphanumeric uppercase character and `_`. |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | User friendly attribute identifier. Name is unique per attribute `class`. Can contain any alphanumeric uppercase character and `_`. Cannot be updated after attribute is created. | string |
| `class` | The type of resource for which the attribute will be used. Cannot be updated after attribute is created. Possible values are `product`, `category` , `user`. `user` is used for both users and usergroups resources. | string |
| `isPublic` | Boolean value. Indicates whether attribute will be publicly available or only within Propeller backoffice. | boolean  <br />Default value is `true` |
| `isSearchable` | Boolean value. It is used only for attributes class `product`. Indicates whether attribute values will be indexed and available for searching. | boolean  <br />Default value is `false` |
| `isSystem` | Boolean value. Special custom usage. System attributes are not visible in the resource Attribute tab in Propeller backoffice. | boolean  <br />Default value is `false` |
| `isHidden` | Boolean value. Special custom usage. Hidden attributes are not visible in the resource Attribute tab in Propeller backoffice. Default value is `false`. | boolean  <br />Default value is `false` |
| `type` | Type of the value. Cannot be updated after attribute is created. Possible values are `text`, `list`, `enum`, `enumlist`, `integer`, `decimal`, `date`, `datetime`.  <br />`list` is a multi value attribute with comma delimited list of values.  <br />`enum` is a single value attribute. The possible values are predefined in a valueset.  <br />`enumlist` is a multi-value attribute. The value is a comma delimited list of values predefined in a valueset. | string |
| `typeParam` (string) | Used in combination with type `enum` and `enumlist`. The name of the valueset that holds all possible values. | string |
| `descriptions` | Attribute description/ label. | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `value` | Attribute default value/ resource value. Possible values depend on `type` | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] (`text`, `list`)  <br />string (`enum`, `enumlist`)  <br />integer  <br />decimal  <br />date  <br />datetime |
| `units` | Attribute unit. Ex. use case: If an attribute is a type of measurement like weight or height, the unit will be kg or cm, etc. | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `group` | Attributes are sometimes related to each other. `group` is used to link them. | string  <br />  <br /> |

## Attribute Errors

This section describes error codes specific for the `Attribute` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `14001` | AttributeNotFound | 404 | Attribute does not exist | Attribute with such lookup key already exists |
| `14002` | AttributeMultipleFound | 400 | Multuple attributes found. Please provide additional filters | Multiple attributes with such lookup key found. Provide additional filters |
| `14003` | AttributeExists | 400 | Attribute already exists | Attribute with such `name` already exists |
| `14004` | AttributeInvalidClass | 400 | No attributes defined for class | Attributes for resources of the provided class are not configured |
| `14005` | AttributeInvalidValue | 400 | Invalid value provided | The attribute value does not correspond with the attribute type |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Authentication

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/authentication.tag

<LegacyBanner />



As already described in [Authentication](/reference/legacy/rest-v1/api-reference#authentication), each request needs a valid `access_token` which once retrieved is valid for 30 minutes.
Use [Get Access Token](/reference/legacy/rest-v1/get-access-token) request to retrieve a valid `access_token`.



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Bulk attributes by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-attributes-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk attributes by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. Usually, multiple attributes need to be created or updated at the same time which is useful to eliminate a lot of API requests. This endpoint is used for bulk processing of attribute definitions based on an Id.

The `id` field is required and when it is 0 a new attribute will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields `name`, `class` and `type` are ignored.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Gewicht"}}},"example":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":644},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"MATERIAAL_FRAME"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"type":"string","example":""},{"type":"string","example":""}]}}},"example":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","id":644,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":0,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]},"examples":{"Bulk attributes by Id":{"value":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","id":644,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":0,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk attributes by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"531"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:24:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bf682c92-6350-46b1-95ad-f0bb6e6e70d7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"error":{"type":"string","example":"Invalid value provided. Attribute type is [text]."},"id":{"type":"number","example":670},"key":{"type":"number","example":644},"lookupKey":{"type":"string","example":"id"},"message":{"type":"string","example":"Attribute created."},"success":{"type":"boolean","example":false}}},"example":[{"action":"update","error":"Invalid value provided. Attribute type is [text].","key":644,"lookupKey":"id","success":false},{"action":"create","id":670,"key":0,"lookupKey":"id","message":"Attribute created.","success":true},{"action":"update","id":668,"key":668,"lookupKey":"id","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"update","error":"Attribute with id [800] not found.","key":800,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":4}}},"examples":{"Bulk attributes by Id - 200":{"value":{"data":[{"action":"update","error":"Invalid value provided. Attribute type is [text].","key":644,"lookupKey":"id","success":false},{"action":"create","id":670,"key":0,"lookupKey":"id","message":"Attribute created.","success":true},{"action":"update","id":668,"key":668,"lookupKey":"id","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"update","error":"Attribute with id [800] not found.","key":800,"lookupKey":"id","success":false}],"messages":["Completed"],"total":4}}}}}},"400":{"description":"Bulk attributes by Id - 400 (missing name)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"799"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:26:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"49c7211c-0ed0-45a6-92ac-976d2f34f874"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/0: required key [name] not found"},"example":["#/0: required key [name] not found","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: JSONArray, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk attributes by Id - 400 (missing name)":{"value":{"error":{"code":10007,"messages":["#/0: required key [name] not found","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: JSONArray, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer","#/0: required key [name] not found","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: Integer"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk attributes by name

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-attributes-by-name.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk attributes by name"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/bulk/name"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. Usually, multiple attributes need to be created or updated at the same time which is useful to eliminate a lot of API requests. This endpoint is used for bulk processing of attribute definitions based on the name.

The `name` field is required and if an attribute with the provided `name` and `class` is not found it will be created, otherwise the attribute definition will be updated. When updating, although part of the request body, the fields `name`, `class` and `type` are ignored.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Gewicht"}}},"example":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"WEIGHT"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"string","example":"2022-12-013"},{"type":"string","example":""}]}}},"example":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"PROMOTION_DATE","type":"date","typeParam":"","value":"2022-12-013"},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]},"examples":{"Bulk attributes by name":{"value":[{"class":"product","descriptions":[{"language":"NL","value":"Gewicht"},{"language":"EN","value":"Weight"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"NL","value":"kg"},{"language":"EN","value":"kg"}],"value":0},{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"PROMOTION_DATE","type":"date","typeParam":"","value":"2022-12-013"},{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk attributes by name - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"484"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:28:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bfd7ccaf-175e-4ab4-9ad2-4eca483271a5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":661},"key":{"type":"string","example":"WEIGHT"},"lookupKey":{"type":"string","example":"name"},"message":{"type":"string","example":"Attribute updated. Fields 'name', 'type' and 'class' are not updated."},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"create","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute created.","success":true},{"action":"update","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk attributes by name - 200":{"value":{"data":[{"action":"update","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true},{"action":"create","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute created.","success":true},{"action":"update","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute updated. Fields 'name', 'type' and 'class' are not updated.","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk attributes by name - 400 (invalid date)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"790"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 19:32:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8c5a3a61-ac6d-4e23-a893-4389a10a778f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/1/type: date is not a valid enum value"},"example":["#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/1/type: date is not a valid enum value","#/1/value: expected type: JSONArray, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Integer, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Number, found: String","#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk attributes by name - 400 (invalid date)":{"value":{"error":{"code":10007,"messages":["#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/1/type: date is not a valid enum value","#/1/value: expected type: JSONArray, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Integer, found: String","#/1/type: date is not a valid enum value","#/1/value: expected type: Number, found: String","#/1/type: date is not a valid enum value","#/1/value: string [2022-12-013] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Categories by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-categories-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Categories by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/categories#category-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `parent` | yes |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-v1/categories#category-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1800},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescription":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"GPS"}}},"example":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]}}},"example":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1800,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"id":1850,"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"id":1900,"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"id":1320},"shortDescription":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Categories by Id":{"value":{"categories":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1800,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"id":1850,"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"id":1900,"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"id":1320},"shortDescription":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}]}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Categories by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"264"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:54:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1c6c3576-f661-472d-a29c-5a6c70da3ea7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":1781},"key":{"type":"number","example":1800},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":1781,"key":1800,"lookupKey":"id","success":true},{"action":"create","id":1783,"key":1850,"lookupKey":"id","success":true},{"action":"create","id":1785,"key":1900,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Categories by Id - 200":{"value":{"data":[{"action":"create","id":1781,"key":1800,"lookupKey":"id","success":true},{"action":"create","id":1783,"key":1850,"lookupKey":"id","success":true},{"action":"create","id":1785,"key":1900,"lookupKey":"id","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk Categories by Id - 400 (Invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"209"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:55:20 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f5d789ba-70e2-437a-ae41-3294e2a93615"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/categories/2: extraneous key [shortDescription] is not permitted"},"example":["#/categories/2: extraneous key [shortDescription] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Categories by Id - 400 (Invalid schema)":{"value":{"error":{"code":10007,"messages":["#/categories/2: extraneous key [shortDescription] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Categories by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-categories-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Categories by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source` and `language`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

A single category's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/categories#category-lookup-keys), but if it's needed to modify attributes for multiple categories, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `categories` (array of category objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `parent` | yes |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-v1/categories#category-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"language":{"type":"string","example":"NL"},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Accessoires"}}},"example":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}]},"parent":{"type":"object","properties":{"sourceId":{"type":"string","example":"136045"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"011000"}}},"example":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"011000"},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"source":"REST-API","sourceId":"020000"},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"source":"REST-API","sourceId":"020100"}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Categories by sourceId":{"value":{"categories":[{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"011000"},{"descriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"language":"NL","names":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"Accessoires"},{"language":"EN","value":"Accessories"}],"source":"REST-API","sourceId":"020000"},{"descriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"language":"NL","names":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"parent":{"sourceId":"136045"},"shortDescriptions":[{"language":"NL","value":"GPS"},{"language":"EN","value":"GPS"}],"source":"REST-API","sourceId":"020100"}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Categories by sourceId - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"294"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:48:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1997ac78-f73f-4729-aa4b-e7b70dd25238"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":1779},"key":{"type":"string","example":"011000"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":1779,"key":"011000","lookupKey":"sourceId","success":true},{"action":"update","id":1775,"key":"020000","lookupKey":"sourceId","success":true},{"action":"update","id":1777,"key":"020100","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Categories by sourceId - 200":{"value":{"data":[{"action":"create","id":1779,"key":"011000","lookupKey":"sourceId","success":true},{"action":"update","id":1775,"key":"020000","lookupKey":"sourceId","success":true},{"action":"update","id":1777,"key":"020100","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk Categories by sourceId - 400 (Invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"246"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:49:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1ddad22b-3864-4d9a-ac78-1b4b38a77b64"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/categories/0: required key [names] not found"},"example":["#/categories/0: required key [names] not found","#/categories/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Categories by sourceId - 400 (Invalid schema)":{"value":{"error":{"code":10007,"messages":["#/categories/0: required key [names] not found","#/categories/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Cluster Options by lookupKey

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-cluster-options-by-lookupkey.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Cluster Options by lookupKey"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk `id` endpoint, the options are identified by Propeller option `id`. If an option with such `id` doesn't already exist, it will be created. If it does exist, the option will be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `isRequired` | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing option that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing option in the parent cluster provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for an option that are not provided in the payload | empty array |
| `skipCreate` | Do not create new options, only update existing | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"COFYR88"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"}]},"options":{"type":"array","items":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"example":[{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},{"descriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"source":"REST-API","sourceId":"KM636000"}]}}},"examples":{"Bulk Cluster Options by lookupKey":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"}],"options":[{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},{"descriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"},{"language":"EN","value":"Keyboard"}],"source":"REST-API","sourceId":"KM636000"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Cluster Options by lookupKey - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"214"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:51:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a508dfec-5778-407d-93b2-3fb7b7c6ccd8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":214},"key":{"type":"string","example":"K72334000"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":214,"key":"K72334000","lookupKey":"sourceId","success":true},{"action":"create","id":216,"key":"KM636000","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Cluster Options by lookupKey - 200":{"value":{"data":[{"action":"update","id":214,"key":"K72334000","lookupKey":"sourceId","success":true},{"action":"create","id":216,"key":"KM636000","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"404":{"description":"Bulk Cluster Options by lookupKey - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:52:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b332a11c-c599-499e-a1d5-cee87c72d8dc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with sourceId [COFYR8800] not found"},"example":["Parent Cluster with sourceId [COFYR8800] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Bulk Cluster Options by lookupKey - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with sourceId [COFYR8800] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Cluster Products by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-cluster-products-by-sourceid.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Cluster Products by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of cluster products with just a single API call. The same lookup key is used for the products as for the cluster. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/clusters#cluster-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-v1/attributes)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"15120300"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"name":{"type":"string","example":"PROPELLER_COLOR"},"type":{"type":"string","example":"text"},"value":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"zwart"}}},"example":[{"language":"NL","value":"zwart"}]}}},"example":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}]},"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044006"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra zwart"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra zwart"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"zwart"}}},"example":[{"language":"NL","value":"zwart"}]},"oemCode":{"type":"string","example":"151201"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra zwart"},"sku":{"type":"string","example":"151201"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151201"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151201"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044006","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra zwart"}],"notes":[{"language":"NL","value":"zwart"}],"oemCode":"151201","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra zwart","sku":"151201","source":"REST-API","sourceId":"151201","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151201","taxCode":"H","unit":1},{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"groen"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675054708","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra groen"}],"notes":[{"language":"NL","value":"groen"}],"oemCode":"151204","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra groen","sku":"151204","source":"REST-API","sourceId":"151204","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151204","taxCode":"H","unit":1}]}}},"examples":{"Bulk Cluster Products by sourceId":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"zwart"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044006","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra zwart"}],"notes":[{"language":"NL","value":"zwart"}],"oemCode":"151201","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra zwart","sku":"151201","source":"REST-API","sourceId":"151201","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151201","taxCode":"H","unit":1},{"attributes":[{"class":"product","name":"PROPELLER_COLOR","type":"text","value":[{"language":"NL","value":"groen"}]}],"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675054708","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra groen"}],"notes":[{"language":"NL","value":"groen"}],"oemCode":"151204","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra groen","sku":"151204","source":"REST-API","sourceId":"151204","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151204","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Cluster Products by sourceId - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"215"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:55:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e234dcc7-892c-40cd-a801-ca6645469424"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":707969},"key":{"type":"string","example":"151201"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":707969,"key":"151201","lookupKey":"sourceId","success":true},{"action":"create","id":707970,"key":"151204","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Cluster Products by sourceId - 200":{"value":{"data":[{"action":"create","id":707969,"key":"151201","lookupKey":"sourceId","success":true},{"action":"create","id":707970,"key":"151204","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"404":{"description":"Bulk Cluster Products by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:56:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b022ca1b-c01b-4706-a31f-1f2e80c6b9ea"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with sourceId [15120300111] not found"},"example":["Parent Cluster with sourceId [15120300111] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Bulk Cluster Products by sourceId - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with sourceId [15120300111] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Clusters by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-clusters-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Clusters by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of clusters with just a single API call. When using the bulk `id` endpoint, the clusters are identified by Propeller cluster `id`. If a cluster with such `id` doesn't already exist, it will be created. If it does exist, the cluster will be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `clusters` (array of cluster objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `parent` | yes |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":9},"code":{"type":"string","example":"030004"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Cluster 5"}}},"example":[{"language":"EN","value":"Cluster 5"}]},"id":{"type":"number","example":700},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Cluster 6"}}},"example":[{"language":"EN","value":"Cluster 6"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}}}},"example":[{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 5"}],"id":700,"names":[{"language":"EN","value":"Cluster 6"}],"parent":{"id":23409}},{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 6"}],"id":701,"names":[{"language":"EN","value":"Cluster 7"}],"parent":{"id":23409}}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}},"examples":{"Bulk Clusters by Id":{"value":{"clusters":[{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 5"}],"id":700,"names":[{"language":"EN","value":"Cluster 6"}],"parent":{"id":23409}},{"clusterConfigId":9,"code":"030004","descriptions":[{"language":"EN","value":"Cluster 6"}],"id":701,"names":[{"language":"EN","value":"Cluster 7"}],"parent":{"id":23409}}],"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"},{"fields":[],"operation":"skipMoveOnUpdate"},{"fields":[],"operation":"mergeTranslationsOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Bulk Clusters by sourceId

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-clusters-by-sourceid.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Clusters by sourceId"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of clusters with just a single API call. When using the bulk `sourceId` endpoint, the clusters are identified by `sourceId`, `source` and `language`. If a cluster doesn't already exist, it will be created. If it does exist, the cluster will be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `clusters` (array of cluster objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `parent` | yes |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |


## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing category that are not empty | array of field names  <br />e.g. names, descriptions, etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing category in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a category that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"examples":{"Bulk Clusters by sourceId":{"value":{"clusters":[{"clusterConfigId":9,"language":"NL","sourceId":"030333335","source":"RESTAPI","names":[{"language":"NL","value":"Cluster 5"}],"code":"030004","parent":{"sourceId":"CLUSTERS"},"descriptions":[{"language":"NL","value":"Cluster 5"}],"options":[{"names":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"language":"NL","sourceId":"030997","source":"RESTAPI","descriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"shortDescriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"isRequired":true},{"names":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"language":"NL","sourceId":"030998","source":"RESTAPI","descriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"shortDescriptions":[{"language":"NL","value":"Third cluster option 2"},{"language":"EN","value":"Third cluster option 2"}],"isRequired":false}],"products":[{"language":"NL","names":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"sku":"NCABD70888","status":"A","descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br>De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br>Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"shortName":"Edge 1030 Fietscomputer","shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"supplier":"TECHDATA","supplierCode":"NCABD70004","oemCode":"NCABD70004","eanCode":"0753759256289","taxCode":"H","price":599.95,"unit":1,"minimumQuantity":1,"manufacturer":"Garmin","costPrice":400.95,"suggestedPrice":580,"package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"notes":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"source":"TECHDATA","sourceId":"NCABD7011114"},{"language":"NL","names":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"sku":"NCABD70004","status":"A","descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br>De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br>Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"shortName":"Edge 1030 Fietscomputer","shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"supplier":"TECHDATA","supplierCode":"NCABD70004","oemCode":"NCABD70004","eanCode":"0753759256289","taxCode":"H","price":599.95,"unit":1,"minimumQuantity":1,"manufacturer":"Garmin","costPrice":400.95,"suggestedPrice":580,"package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"notes":[{"language":"NL","value":"Edge 1030 Fietscomputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"source":"TECHDATA","sourceId":"NCABD7022225"}]},{"clusterConfigId":9,"language":"NL","sourceId":"030777","source":"RESTAPI","names":[{"language":"NL","value":"Cluster 6"}],"code":"030004","parent":{"sourceId":"CLUSTERS"},"descriptions":[{"language":"NL","value":"Cluster 6"}]}],"directives":[{"operation":"skipIfNotEmpty","fields":["names","descriptions"]},{"operation":"skipMoveOnUpdate","fields":[]},{"operation":"mergeTranslationsOnUpdate","fields":[]}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Bulk Companies by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-companies-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Companies by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk `id` endpoint, the companies are identified by `id`. If a company with such `id` doesn't already exist, it will be created. If it does exist, the company found will be updated.

Company bulk endpoints support bulk change of attributes for multiple companies as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Company bulk endpoints support bulk change of pricing for multiple companies as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single company's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/companies#company-lookup-keys), but if it's needed to modify attributes for multiple companies in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `companies` (array of company objects) | yes |
| `id` | yes |
| `name` | no |
| `language` | no |
| `parent` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `debtorId` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing company that are not empty | array of field names  <br />e.g. name, office etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing company in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"companies":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"company":{"type":"string","example":""},"debtorId":{"type":"string","example":"75564998"},"department":{"type":"string","example":""},"id":{"type":"number","example":9482},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Usergroup created from API"},"parent":{"type":"object","properties":{"id":{"type":"number","example":209}}},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"example":[{"budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"","debtorId":"75564998","department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Usergroup created from API","parent":{"id":209},"taxNumber":"NL860325386B01"}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]}}},"examples":{"Bulk Companies by Id":{"value":{"companies":[{"budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"","debtorId":"75564998","department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Usergroup created from API","parent":{"id":209},"taxNumber":"NL860325386B01"}],"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Companies by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"120"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:44:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"efac917b-4865-4186-a051-4c328437bac4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":9482},"key":{"type":"number","example":9482},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":9482,"key":9482,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Companies by Id - 200":{"value":{"data":[{"action":"update","id":9482,"key":9482,"lookupKey":"id","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Companies by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:45:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"52c77090-b7e2-466f-a62e-6fc0a34af5fd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/companies/0: extraneous key [company] is not permitted"},"example":["#/companies/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Companies by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/companies/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Companies by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-companies-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Companies by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of companies with just a single API call. When using the bulk `sourceId` endpoint, the companies are identified by `sourceId`, `source` and `language`. If a company doesn't already exist, it will be created. If it does exist, the company found will be updated.

Company bulk endpoints support bulk change of attributes for multiple companies as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Company bulk endpoints support bulk change of pricing for multiple companies as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single company's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/companies#company-lookup-keys), but if it's needed to modify attributes for multiple companies in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `companies` (array of company objects) | yes |
| `source` | yes |
| `sourceId` | yes |
| `name` | no |
| `language` | yes |
| `parent` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `debtorId` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing company that are not empty | array of field names  <br />e.g. name, office etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing company in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"companies":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"company":{"type":"string","example":"Propeller B.V."},"debtorId":{"type":"string","example":"75564998"},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"sourceId":{"type":"number","example":100000}}},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":200001},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"example":[{"budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"Propeller B.V.","debtorId":"75564998","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Usergroup created from API","office":"","parent":{"sourceId":100000},"source":"REST-API","sourceId":200001,"taxNumber":"NL860325386B01"}]},"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]}}},"examples":{"Bulk Companies by source id":{"value":{"companies":[{"budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"Propeller B.V.","debtorId":"75564998","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Usergroup created from API","office":"","parent":{"sourceId":100000},"source":"REST-API","sourceId":200001,"taxNumber":"NL860325386B01"}],"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Companies by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"126"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:39:13 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"508c5d67-42b5-45cb-a226-c5b5da54a5a8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":9483},"key":{"type":"number","example":200001},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":9483,"key":200001,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Companies by source id - 200":{"value":{"data":[{"action":"create","id":9483,"key":200001,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Companies by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:41:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"44ac19a1-b434-4ecc-b84d-3460beba4a37"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/companies/0: extraneous key [company] is not permitted"},"example":["#/companies/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Companies by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/companies/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Company Bulk Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-company-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Company Bulk Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple company addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"U"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"U","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Company Bulk Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"U","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Company Bulk Addresses - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:53:21 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"84e830d7-05ce-4627-8b6d-f8fb16236a91"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":106076},"key":{"type":"string","example":"11234"},"lookupKey":{"type":"string","example":"code"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":106076,"key":"11234","lookupKey":"code","success":true},{"action":"create","id":106078,"key":"11235","lookupKey":"code","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Company Bulk Addresses - 200":{"value":{"data":[{"action":"update","id":106076,"key":"11234","lookupKey":"code","success":true},{"action":"create","id":106078,"key":"11235","lookupKey":"code","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Company Bulk Addresses - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"195"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:54:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a4bce8dd-2acb-4ceb-9e82-010106021fb0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/addresses/0/isDefault: U is not a valid enum value"},"example":["#/addresses/0/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Company Bulk Addresses - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/addresses/0/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Company Bulk Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:53:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e51ea8eb-0138-41c3-bb23-445383026f55"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Company Bulk Addresses - 404":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Contacts by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-contacts-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Contacts by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/contacts/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `id` endpoint, the contacts are identified by `id`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.

Contact bulk endpoints support bulk change of contact attributes for multiple contacts as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Contact bulk endpoints support bulk change of pricing for multiple contacts as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single contact attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/contacts#contact-lookup-keys), but if it's needed to modify attributes for multiple contacts, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `contacts` (array of contact objects) | yes |
| `id` | yes |
| `debtorId` (deprecated) | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `abbreviation` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `ssn` | no |
| `phone` | no |
| `email` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"company":{"type":"string","example":"Propeller"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25492},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"id":{"type":"number","example":9482}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25492,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"EN","title":"Mr."}]}}},"examples":{"Bulk Contacts by Id":{"value":{"contacts":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25492,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"EN","title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Contacts by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"122"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:14:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e1e339c5-1575-4855-83b4-adab6033bc52"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":25492},"key":{"type":"number","example":25492},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":25492,"key":25492,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Contacts by Id - 200":{"value":{"data":[{"action":"update","id":25492,"key":25492,"lookupKey":"id","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Contacts by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:14:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"5355d6fb-94a8-4566-b0e4-abaa407f2a45"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/contacts/0: extraneous key [company] is not permitted"},"example":["#/contacts/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Contacts by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/contacts/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Contacts by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-contacts-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Contacts by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/contacts/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `sourceId` endpoint, the contacts are identified by `sourceId`, `source` and `language`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.

Contact bulk endpoints support bulk change of contact attributes for multiple contacts as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Contact bulk endpoints support bulk change of pricing for multiple contacts as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single contacts attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/contacts#contact-lookup-keys), but if it's needed to modify attributes for multiple contacts, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `contacts` (array of contact objects) | yes |
| `source` | yes |
| `sourceId` | yes |
| `debtorId` (deprecated) | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `abbreviation` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `ssn` | no |
| `phone` | no |
| `email` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"company":{"type":"string","example":"Propeller"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3000000}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"source":"REST-API","sourceId":3000000},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}},"examples":{"Bulk Contacts by source id":{"value":{"contacts":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"source":"REST-API","sourceId":3000000},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Contacts by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"128"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:58:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"4f34344d-2bd6-419a-8cdf-ab92c6d6bd0d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":25492},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":25492,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Contacts by source id - 200":{"value":{"data":[{"action":"update","id":25492,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Contacts by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:58:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bf271127-02c2-4f77-b777-b924fa99e3ee"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/contacts/0: extraneous key [company] is not permitted"},"example":["#/contacts/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Contacts by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/contacts/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Customer Bulk Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-customer-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Customer Bulk Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple customer addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"U"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"U","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Customer Bulk Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"U","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Customer Bulk Addresses - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:45:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"35b864a6-4eee-4056-9d7b-11db864e716f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":106097},"key":{"type":"string","example":"11234"},"lookupKey":{"type":"string","example":"code"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":106097,"key":"11234","lookupKey":"code","success":true},{"action":"create","id":106104,"key":"11235","lookupKey":"code","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Customer Bulk Addresses - 200":{"value":{"data":[{"action":"update","id":106097,"key":"11234","lookupKey":"code","success":true},{"action":"create","id":106104,"key":"11235","lookupKey":"code","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Customer Bulk Addresses - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:46:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"627ad968-9d2b-4ac8-abe1-57eae2867cd0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/addresses/0/icp: U is not a valid enum value"},"example":["#/addresses/0/icp: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Customer Bulk Addresses - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/addresses/0/icp: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Customer Bulk Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:46:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"183c702b-44a3-4f37-a7bd-137fb22569fc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Customer Bulk Addresses - 404":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Customers by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-customers-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Customers by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk `id` endpoint, the customers are identified by `id`. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.

Customer bulk endpoints support bulk change of customer attributes for multiple customers as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Customer bulk endpoints support bulk change of pricing for multiple customers as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single customer attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/customers#customer-lookup-keys), but if it's needed to modify attributes for multiple customers, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `customers` (array of customer objects) | yes |
| `id` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `abbreviation` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `ssn` | no |
| `phone` | no |
| `email` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"company":{"type":"string","example":"Propeller"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25494},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}],"attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25494,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":109},"phone":"0032445888","primaryLanguage":"EN","title":"Mr."}]}}},"examples":{"Bulk Customers by Id":{"value":{"customers":[{"abbreviation":"MM","addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}],"attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25494,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":109},"phone":"0032445888","primaryLanguage":"EN","title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Customers by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"122"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:54:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"49690529-2e41-48b6-a993-5c9f65e7e2c8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":25494},"key":{"type":"number","example":25494},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":25494,"key":25494,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Customers by Id - 200":{"value":{"data":[{"action":"update","id":25494,"key":25494,"lookupKey":"id","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Customers by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:55:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"1593560b-b180-4ada-bba6-a4c347c89982"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/customers/0: extraneous key [company] is not permitted"},"example":["#/customers/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Customers by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/customers/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Customers by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-customers-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Customers by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of customers with just a single API call. When using the bulk `sourceId` endpoint, the customers are identified by `sourceId`, `source` and `language`. If a customer doesn't already exist, it will be created. If it does exist, the customer found will be updated.

Customer bulk endpoints support bulk change of customer attributes for multiple customers as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Customer bulk endpoints support bulk change of pricing for multiple customers as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single customer attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/customers#customer-lookup-keys), but if it's needed to modify attributes for multiple customers, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `customers` (array of customer objects) | yes |
| `source` | yes |
| `sourceId` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `abbreviation` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `ssn` | no |
| `phone` | no |
| `email` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"company":{"type":"string","example":"Propeller"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"source":{"type":"string","example":"RCEB0451-3"},"sourceId":{"type":"string","example":"199605"}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}],"attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"source":"RCEB0451-3","sourceId":"199605"},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}},"examples":{"Bulk Customers by source id":{"value":{"customers":[{"abbreviation":"MM","addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}],"attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"company":"Propeller","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"source":"RCEB0451-3","sourceId":"199605"},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Customers by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"128"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:50:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"369d9afe-f44b-4b0d-973d-ab7f1de81e97"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":25494},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":25494,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Customers by source id - 200":{"value":{"data":[{"action":"update","id":25494,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Customers by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:50:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"418f6053-714d-4aa8-bc64-64a55eacbddd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/customers/0: extraneous key [company] is not permitted"},"example":["#/customers/0: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Customers by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/customers/0: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk images

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-images.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk images"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/media/images/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



## Fields

| **Name** | **Description** | **Type** | **Required** |
| --- | --- | --- | --- |
|  | Array of mediaImage objects | array\[[MediaImage](#mediaimage-input)\] | yes |

## MediaImage input

| **Name** | **Description** | **Type** | **Required** |
| --- | --- | --- | --- |
| `productId` | Id of the product resource the image should be linked to | integer | no |
| `source` | External system  <br />Read [more](/reference/legacy/rest-v1/api-reference#lookup-keys) about lookup key source/sourceId | string | yes |
| `sourceId` | External system unique id  <br />Read [more](/reference/legacy/rest-v1/api-reference#lookup-keys) about lookup key source/sourceId | string | yes |
| `priority` | Image display priority (lower value has higher priority)  <br />Default is `1000` | integer | no |
| `alt` | Image alt description that briefly explains the contents of the image | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] | yes |
| `description` | Image short description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] | yes |
| `tags` | Free format field to categorize image on type (e.g. logo, banner, icon, etc) | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] | yes |
| `uploadImages` |  | array\[[UploadImages](#uploadimages-input)\] | `yes` |

## UploadImages input

| **Name** | **Description** | **Type** | **Required** |
| --- | --- | --- | --- |
| `language` | Language specific image  <br />Default is `en` | string | no |
| `uploadType` | Default is `URL` | string | no |
| `urlFile` |  | [UrlFile](#urlfile-input) object |  |

## UrlFile input

| **Name** | **Description** | **Type** | **Required** |
| --- | --- | --- | --- |
| `url` | Public url to the image | string | yes |
| `fileName` | Name to use for storing the file | string | yes |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"alt":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"en"},"value":{"type":"string","example":"Lorem_Ipsum"}}},"example":[{"language":"en","value":"Lorem_Ipsum"}]},"description":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"en"},"value":{"type":"string","example":"Lorem Ipsum"}}},"example":[{"language":"en","value":"Lorem Ipsum"}]},"priority":{"type":"number","example":1},"productId":{"type":"number","example":421},"source":{"type":"string","example":"MBC"},"sourceId":{"type":"string","example":"Lorem_Ipsum_1"},"tags":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"en"},"values":{"type":"array","items":{"type":"string","example":"image"},"example":["image"]}}},"example":[{"language":"en","values":["image"]}]},"uploadImages":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"en"},"uploadType":{"type":"string","example":"URL"},"urlFile":{"type":"object","properties":{"fileName":{"type":"string","example":"Computer_modern.jpg"},"url":{"type":"string","example":"https://upload.wikimedia.org/wikipedia/commons/b/bd/Computer_modern.jpg"}}}}},"example":[{"language":"en","uploadType":"URL","urlFile":{"fileName":"Computer_modern.jpg","url":"https://upload.wikimedia.org/wikipedia/commons/b/bd/Computer_modern.jpg"}}]}}},"examples":{"Bulk images":{"value":{"alt":[{"language":"en","value":"Lorem_Ipsum"}],"description":[{"language":"en","value":"Lorem Ipsum"}],"priority":1,"productId":421,"source":"MBC","sourceId":"Lorem_Ipsum_1","tags":[{"language":"en","values":["image"]}],"uploadImages":[{"language":"en","uploadType":"URL","urlFile":{"fileName":"Computer_modern.jpg","url":"https://upload.wikimedia.org/wikipedia/commons/b/bd/Computer_modern.jpg"}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk images - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"293"}},"date":{"schema":{"type":"string","example":"Mon, 08 May 2023 13:02:18 GMT"}},"etag":{"schema":{"type":"string","example":"W/\"125-Nt504due08WE01xQ263Caxlg1Cs\""}},"x-powered-by":{"schema":{"type":"string","example":"Express"}},"x-request-id":{"schema":{"type":"string","example":"150e030c-f957-4563-b49a-7d4bfeeb3463"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"string","example":"8096d15a-128f-4603-ac33-38c53f8e36d6"},"key":{"type":"string","example":"Lorem_Ipsum_1"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":"8096d15a-128f-4603-ac33-38c53f8e36d6","key":"Lorem_Ipsum_1","lookupKey":"sourceId","success":true},{"action":"update","id":"ef725b14-dd81-4350-b004-bb065cb82e14","key":"Lorem_Ipsum_2","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk images - 200":{"value":{"data":[{"action":"update","id":"8096d15a-128f-4603-ac33-38c53f8e36d6","key":"Lorem_Ipsum_1","lookupKey":"sourceId","success":true},{"action":"update","id":"ef725b14-dd81-4350-b004-bb065cb82e14","key":"Lorem_Ipsum_2","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk images - 400 / Bulk images - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"96"}},"date":{"schema":{"type":"string","example":"Mon, 08 May 2023 13:12:48 GMT"}},"etag":{"schema":{"type":"string","example":"W/\"60-lYcwBYhLbpaGl8Vb4w4KJlmDLH4\""}},"x-powered-by":{"schema":{"type":"string","example":"Express"}},"x-request-id":{"schema":{"type":"string","example":"b110f549-7673-4611-ad96-df177c389f1e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request"},"message":{"example":["source must be shorter than or equal to 32 characters","source should not be empty","source must be a string","sourceId must be shorter than or equal to 64 characters","sourceId should not be empty","sourceId must be a string"],"anyOf":[{"type":"array","items":{"type":"string","example":"source must be shorter than or equal to 32 characters"},"example":["source must be shorter than or equal to 32 characters","source should not be empty","source must be a string","sourceId must be shorter than or equal to 64 characters","sourceId should not be empty","sourceId must be a string"]},{"type":"string","example":"Validation failed (parsable array expected)"}]},"statusCode":{"type":"number","example":400}}},"examples":{"Bulk images - 400":{"value":{"error":"Bad Request","message":["source must be shorter than or equal to 32 characters","source should not be empty","source must be a string","sourceId must be shorter than or equal to 64 characters","sourceId should not be empty","sourceId must be a string"],"statusCode":400}},"Bulk images - 400 (invalid schema)":{"value":{"error":"Bad Request","message":"Validation failed (parsable array expected)","statusCode":400}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Inventory by lookup key / inventory type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-inventory-by-lookup-key-inventory-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Inventory by lookup key / inventory type"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/{lookupKey}/{inventoryType}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk inventory endpoint is used to create or update inventory records. The products can be identified based on one of their lookup keys. The inventory record type can be either `local` or `supplier`.

When looking up an inventory record, the matching fields are: `lookupKey`, `warehouseId` and `location`. If a record already exists it will be updated, otherwise a new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `sku` (string) | only when lookup key is `sku` |
| `supplierCode` (string) | only when lookup key is `supplierCode` |
| `supplier` (string) | only when lookup key is `supplierCode` |
| `id` (integer) | only when lookup key is `id` |
| `sourceId` (string) | only when lookup key is `sourceId` |
| `source` (string) | only when lookup key is `sourceId` |
| `language` (string) | only when lookup key is `sourceId` |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"sourceId"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"inventoryType","in":"path","required":true,"schema":{"type":"string","example":"supplier"},"description":"Inventory type. `local` or `supplier`"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"company":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TESTSOURCE"},"sourceId":{"type":"number","example":1}}},"language":{"type":"string","example":"NL"},"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-03-01 00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":77},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143111}}}}},"example":[{"language":"NL","location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":77,"source":"TECHDATA","sourceId":"NCABD70004","usergroup":{"id":143111}},{"company":{"language":"NL","source":"TESTSOURCE","sourceId":1},"language":"NL","quantity":87,"source":"TECHDATA","sourceId":"NCABD70004"}]}}},"examples":{"Bulk Inventory by lookup key / inventory type":{"value":{"inventory":[{"language":"NL","location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":77,"source":"TECHDATA","sourceId":"NCABD70004","usergroup":{"id":143111}},{"company":{"language":"NL","source":"TESTSOURCE","sourceId":1},"language":"NL","quantity":87,"source":"TECHDATA","sourceId":"NCABD70004"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk supplier inventory by source id - 200 / Bulk local inventory by sourceId - 200 / Bulk supplier inventory by supplier code - 200 / Bulk local inventory by sku - 200 / Bulk local inventory by Id - 200 / Bulk supplier inventory by source id for company and usergroup - 200 / Bulk supplier inventory by source id for company and non existing usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"178"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 19:36:04 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":16134},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":16134,"success":true},{"action":"update","id":16135,"success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk local inventory by Id - 200":{"value":{"data":[{"action":"update","id":16131,"success":true},{"action":"create","id":16138,"success":true}],"messages":["Completed"],"total":2}},"Bulk local inventory by sku - 200":{"value":{"data":[{"action":"update","id":16131,"success":true},{"action":"update","id":16132,"success":true}],"messages":["Completed"],"total":2}},"Bulk local inventory by sourceId - 200":{"value":{"data":[{"action":"create","id":16136,"success":true},{"action":"create","id":16137,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id - 200":{"value":{"data":[{"action":"update","id":16134,"success":true},{"action":"update","id":16135,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id for company and non existing usergroup - 200":{"value":{"data":[{"action":"create","message":"Usergroup with id [143111] not found","success":false},{"action":"update","id":16139,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by source id for company and usergroup - 200":{"value":{"data":[{"action":"update","id":16141,"success":true},{"action":"update","id":16139,"success":true}],"messages":["Completed"],"total":2}},"Bulk supplier inventory by supplier code - 200":{"value":{"data":[{"action":"create","message":"Product with supplierCode [757540] not found","success":false},{"action":"update","id":16125,"success":true},{"action":"update","id":16126,"success":true}],"messages":["Completed"],"total":3}}}}}},"400":{"description":"Bulk supplier inventory by source id - 400 (invalid inventory type) / Bulk supplier inventory by sourceId - 400 (invalid lookup key)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"242"}},"Date":{"schema":{"type":"string","example":"Mon, 29 Aug 2022 21:24:02 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13007},"messages":{"type":"array","items":{"type":"string","example":"Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"},"example":["Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidInventoryType"}}}}},"examples":{"Bulk supplier inventory by source id - 400 (invalid inventory type)":{"value":{"error":{"code":13007,"messages":["Invalid inventory type [suppliers], type must contain one of the following values: [local,supplier]"],"moreInfo":"https://www.propel.us/docs/errors/13007","status":400,"type":"InvalidInventoryType"}}},"Bulk supplier inventory by sourceId - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [sourceIds], key must contain one of the following values: [id,sourceId,sku,suppliercode]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Links by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-links-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Links by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/links/bulk/{lookupKey}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of links with just a single API call. When using the bulk `id` endpoint, the link resources are identified by Propeller `id`. If a link for resources with such `id` doesn't already exist, it will be created. If it does exist, it will be updated.

When using the bulk `sourceId` endpoint, the link resources are identified by Propeller `sourceId` and `source`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `subtype` | yes |
| `isDefault` | no  <br />Defaults to `false` |
| `isActive` | no  <br />Defaults to `true` |
| `from` | yes |
| `to` | yes  <br /> |
| `priority` | no  <br />Default to 0 |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"From and to resources lookup keys. `id` and `sourceId` are supported."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD7000411"}}},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"subtype":{"type":"string","example":"normal"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"}}},"type":{"type":"string","example":"accessories-dummy"}}},"example":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"},"type":"accessories-dummy"},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"},"type":"alternatives"}]}}},"examples":{"Bulk Links by lookup key":{"value":{"links":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"},"type":"accessories-dummy"},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"isActive":true,"isDefault":true,"subtype":"normal","to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"},"type":"alternatives"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Links by Id - 200 / Bulk Links by Id - 200 (Product cross/upsell use case) / Bulk Links by sourceId - 200 (Product cross/upsell use case)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"502"}},"Date":{"schema":{"type":"string","example":"Fri, 14 Jul 2023 14:08:51 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","example":"Customer with id [19815] not found"},"from":{"type":"object","properties":{"class":{"type":"string","example":"customer"},"id":{"type":"number","example":19815}}},"id":{"type":"number","example":543843},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":false},"to":{"type":"object","properties":{"class":{"type":"string","example":"company"},"id":{"type":"number","example":204}}}}},"example":[{"error":"Customer with id [19815] not found","from":{"class":"customer","id":19815},"lookupKey":"id","success":false,"to":{"class":"company","id":204}},{"from":{"class":"contact","id":14575},"id":543843,"lookupKey":"id","success":true,"to":{"class":"company","id":150}}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Links by Id - 200":{"value":{"data":[{"error":"Customer with id [19815] not found","from":{"class":"customer","id":19815},"lookupKey":"id","success":false,"to":{"class":"company","id":204}},{"from":{"class":"contact","id":14575},"id":543843,"lookupKey":"id","success":true,"to":{"class":"company","id":150}}],"messages":["Completed"],"total":2}},"Bulk Links by Id - 200 (Product cross/upsell use case)":{"value":{"data":[{"from":{"class":"product","id":227293},"id":543973,"lookupKey":"id","success":true,"to":{"class":"product","id":227294}},{"from":{"class":"product","id":227293},"id":543974,"lookupKey":"id","success":true,"to":{"class":"product","id":227292}}],"messages":["Completed"],"total":2}},"Bulk Links by sourceId - 200 (Product cross/upsell use case)":{"value":{"data":[{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"id":543975,"lookupKey":"sourceId","success":true,"to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004"}},{"from":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD7000411"},"id":543976,"lookupKey":"sourceId","success":true,"to":{"class":"product","language":"NL","source":"TECHDATA","sourceId":"NCABD70004123"}}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Links by lookup key - 400 (invalid lookup key) / Bulk Links by sourceId - 400 (schema validation error)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"202"}},"Date":{"schema":{"type":"string","example":"Fri, 14 Jul 2023 14:10:45 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Bulk Links by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}},"Bulk Links by sourceId - 400 (schema validation error)":{"value":{"error":{"code":10007,"messages":["#/links/0/type: accessories-dummy is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Local Inventory (deprecated)

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-local-inventory-deprecated.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Local Inventory (deprecated)"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk local inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of `Bulk Inventory by lookup key / inventory type` where you can use the same payload, but you need to set the lookup key param to `sku` and the inventory type param to `local`.

On creating a record, inventory type **local** is matching the product on the field **sku**. If the product is found, inventory record will be created.

For updating a record, matching fields are: **sku**, **warehouseId** and **location**. Record is updated only when inventory record with all three matching fields is found, otherwise new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `sku` (string) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-03-01T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":13},"sku":{"type":"string","example":"AA 0635613"},"warehouseId":{"type":"number","example":2}}},"example":[{"quantity":13,"sku":"AA 0635613"},{"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","quantity":3,"sku":"757540","warehouseId":2}]}}},"examples":{"Bulk Local Inventory (deprecated)":{"value":{"inventory":[{"quantity":13,"sku":"AA 0635613"},{"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","quantity":3,"sku":"757540","warehouseId":2}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Local Inventory - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"117"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:49:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2bcc0c26-613c-4e37-b317-d472031a42d4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","success":true},{"action":"update","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Local Inventory - 200":{"value":{"data":[{"action":"update","success":true},{"action":"update","success":true}],"messages":["Completed"],"total":2}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Product by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-product-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Product by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/products#product-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `parent` | no |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |

For more details on `attributes` field, read [this.](/reference/legacy/rest-v1/products#product-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"name":{"type":"string","example":"PROPELLOR_LABEL_1"},"type":{"type":"string","example":"text"},"value":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"FietsComputer"}}},"example":[{"language":"NL","value":"FietsComputer"}]}}},"example":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}]},"brand":{"type":"string","example":"Garmin"},"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40366},"language":{"type":"string","example":"NL"},"minimumQuantity":{"type":"number","example":1},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"attributes":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}],"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40366,"language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","id":40368,"language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}},"examples":{"Bulk Product by Id":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"attributes":[{"class":"product","name":"PROPELLOR_LABEL_1","type":"text","value":[{"language":"NL","value":"FietsComputer"}]},{"class":"product","name":"PROPELLOR_LABEL_2","type":"text","value":[{"language":"NL","value":"Garmin"}]}],"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40366,"language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","id":40368,"language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:31:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a3b9ed62-8e3b-4461-a35c-10b6d93dafce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":40366},"key":{"type":"number","example":0},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":40366,"key":0,"lookupKey":"id","success":true},{"action":"create","id":40368,"key":48118,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Product by Id - 200":{"value":{"data":[{"action":"create","id":40366,"key":0,"lookupKey":"id","success":true},{"action":"create","id":40368,"key":48118,"lookupKey":"id","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Product by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:34:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"753ccea0-3d08-4a73-af3c-3333c94ff61c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/products/0: required key [names] not found"},"example":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Product by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Product by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-product-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Product by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of products with just a single API call. When using the bulk `sourceId` endpoint, the products are identified by `sourceId`, `source` and `language`. If a product doesn't already exist, it will be created. If it does exist, the product found will be updated.

Product Bulk endpoints support bulk change of product attributes for multiple products as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

A single product's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/products#product-lookup-keys), but if it's needed to modify attributes for multiple products, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `products` (array of product objects) | yes |
| `sourceId` | yes |
| `source` | yes |
| `language` | yes |
| `names` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `packageDescriptions` | no |
| `notes` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `parent` | no |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |


For more details on `attributes` field, read [this.](/reference/legacy/rest-v1/products#product-lookup-keys)

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing product that are not empty | array of field names  <br />e.g. names, descriptions, packageDescriptions etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing product in the parent category provided | empty array |
| `mergeTranslationsOnUpdate` | On update, delete all translation for a product that are not provided in the payload | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string","example":"names"},"example":["names","descriptions"]},"operation":{"type":"string","example":"skipIfNotEmpty"}}},"example":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}]},"products":{"type":"array","items":{"type":"object","properties":{"brand":{"type":"string","example":"Garmin"},"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"language":{"type":"string","example":"NL"},"minimumQuantity":{"type":"number","example":1},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020100"}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"example":[{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","source":"TECHDATA","sourceId":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}},"examples":{"Bulk Product by source id":{"value":{"directives":[{"fields":["names","descriptions"],"operation":"skipIfNotEmpty"}],"products":[{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","minimumQuantity":1,"name":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},{"brand":"Garmin","costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256211","language":"NL","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"},{"language":"EN","value":"Edge 1050 Bike computer"}],"oemCode":"NCABD70005","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"source":"REST-API","sourceId":"020100"},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1050 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","source":"TECHDATA","sourceId":"NCABD70005","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","unit":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Product by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"221"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:26:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"db53b21e-a47d-45d8-a561-5bc661d5d06b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":40362},"key":{"type":"string","example":"NCABD70004"},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":40362,"key":"NCABD70004","lookupKey":"sourceId","success":true},{"action":"create","id":40364,"key":"NCABD70005","lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":2}}},"examples":{"Bulk Product by source id - 200":{"value":{"data":[{"action":"create","id":40362,"key":"NCABD70004","lookupKey":"sourceId","success":true},{"action":"create","id":40364,"key":"NCABD70005","lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":2}}}}}},"400":{"description":"Bulk Product by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:28:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"59b15fa3-b7ef-4397-9991-b861daf5962a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/products/0: required key [names] not found"},"example":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Product by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/products/0: required key [names] not found","#/products/0: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk resource attribute values by resource lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-resource-attribute-values-by-resource-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk resource attribute values by resource lookup key"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk resource attribute endpoint sets/ deletes resource attributes for a single resource identified by the [lookup key](/reference/legacy/rest-v1/attributes#attribute-lookup-keys). The attribute is identified via the payload by providing either `id` or `name`. If both are provided, `id` will be used to identify the attribute. Below is a summary of all the possible fields in the payload.

## Fields

| **Name** | **Required** |
| --- | --- |
| `id` | yes, if `name` not provided |
| `name` | yes, if `id` not specified |
| `class` | yes, if `id` not specified |
| `type` | yes |
| `value` | no, if omitted the attribute value will be deleted for the resource (set to default) |

A successful response contains data about each attribute changes: whether the attribute was created/ updated for that resource, in which case the `action` in the response will be `put`, or `delete` if the value of the attribute for the particular resource is being deleted. After it is deleted, the attribute value for the specific resource will inherit the value from the parent resource(s).

In case of an issue, the data will contain a message explaining the reason, for ex. when an attribute is not found, or the value provided does not match the attribute type, etc.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-v1/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_REKENING"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"Y"}}},"example":[{"class":"user","name":"SHOW_REKENING","type":"enum","value":"Y"}]},"examples":{"Bulk resource attribute values by resource lookup key":{"value":[{"class":"user","name":"SHOW_REKENING","type":"enum","value":"Y"}]}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk product attribute values by product id - 200 / Bulk product attribute values by product source id - 200 / Bulk user attribute values by user id and attribute name - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 11:47:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"86561cda-74b1-44a5-bc18-7a0c6b71c7b3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"put"},"error":{"type":"string","example":"Attribute with name [HEIGHT] not found."},"id":{"type":"number","example":661},"key":{"type":"string","example":"WEIGHT"},"lookupKey":{"type":"string","example":"name"},"message":{"type":"string","example":"Attribute value put."},"success":{"type":"boolean","example":true},"value":{"example":15,"anyOf":[{"type":"number","example":15},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Leer"}}},"example":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]}]}}},"example":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":4}}},"examples":{"Bulk product attribute values by product id - 200":{"value":{"data":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}],"messages":["Completed"],"total":4}},"Bulk product attribute values by product source id - 200":{"value":{"data":[{"action":"put","id":661,"key":"WEIGHT","lookupKey":"name","message":"Attribute value put.","success":true,"value":15},{"action":"put","id":671,"key":"MATERIAAL_FRAME","lookupKey":"name","message":"Attribute value put.","success":true,"value":[{"language":"NL","value":"Leer"},{"language":"EN","value":"Leather"}]},{"action":"put","error":"Attribute with name [HEIGHT] not found.","key":"HEIGHT","lookupKey":"name","success":false},{"action":"delete","id":668,"key":"COLOR","lookupKey":"name","message":"Attribute value deleted (set to default).","success":true}],"messages":["Completed"],"total":4}},"Bulk user attribute values by user id and attribute name - 200":{"value":{"data":[{"action":"put","id":48,"key":"SHOW_REKENING","lookupKey":"name","message":"Attribute value put.","success":true,"value":"Y"}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk product attribute values by product id - 400 (schema validation error)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"636"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 13:51:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0414e304-7170-4878-ab25-c744c595cd6a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/0/type: decimal is not a valid enum value"},"example":["#/0/type: decimal is not a valid enum value","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: Integer, found: JSONArray","#/0/value: expected type: Number, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk product attribute values by product id - 400 (schema validation error)":{"value":{"error":{"code":10007,"messages":["#/0/type: decimal is not a valid enum value","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: Integer, found: JSONArray","#/0/value: expected type: Number, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray","#/0/type: decimal is not a valid enum value","#/0/value: expected type: String, found: JSONArray"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk product attribute values by product id - 404 / Bulk product attribute values by product source id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 14:26:10 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"68df5e8c-6053-45d1-9b00-3c9e88bfdd33"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10009},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Product] with id [372212] not found."},"example":["Parent resource [Product] with id [372212] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10009"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentProductNotFound"}}}}},"examples":{"Bulk product attribute values by product id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with id [372212] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}},"Bulk product attribute values by product source id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with sourceId [076548] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Supplier Inventory (deprecated)

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-supplier-inventory-deprecated.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Supplier Inventory (deprecated)"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/bulk/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk supplier inventory endpoint is used to create or update inventory records.

This endpoint is deprecated in favor of `Bulk Inventory by lookup key / inventory type` where you can use the same payload, but you need to set the lookup key param to `supplierCode` and the inventory type param to `supplier`.

On creating a record, inventory type **supplier** is matching the product on two fields: **supplier** and **supplierCode**. If the product is found, inventory record will be created.

For updating a record, matching fields are: **supplier**, **supplierCode**, **warehouseId** and **location**. Record is updated only when inventory record with all four matching fields is found, otherwise new record is created.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `supplier` (string) | yes |
| `supplierCode` (string) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2021-02-25T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":15},"supplier":{"type":"string","example":"QUANTORE"},"supplierCode":{"type":"string","example":"757540"},"warehouseId":{"type":"number","example":4}}},"example":[{"nextDeliveryDate":"2021-02-25T00:00:00","notes":"","quantity":15,"supplier":"QUANTORE","supplierCode":"757540","warehouseId":4},{"location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":3,"supplier":"QUANTORE","supplierCode":"851071","warehouseId":2},{"quantity":5,"supplier":"KERRIDGE","supplierCode":"AA 0635613"}]}}},"examples":{"Bulk Supplier Inventory (deprecated)":{"value":{"inventory":[{"nextDeliveryDate":"2021-02-25T00:00:00","notes":"","quantity":15,"supplier":"QUANTORE","supplierCode":"757540","warehouseId":4},{"location":"B45","nextDeliveryDate":"2021-03-01 00:00:00","notes":"","quantity":3,"supplier":"QUANTORE","supplierCode":"851071","warehouseId":2},{"quantity":5,"supplier":"KERRIDGE","supplierCode":"AA 0635613"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Supplier Inventory - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"152"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:46:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a390db21-cbe8-456d-acc8-ce487d9176fe"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","success":true},{"action":"create","success":true},{"action":"update","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Bulk Supplier Inventory - 200":{"value":{"data":[{"action":"update","success":true},{"action":"create","success":true},{"action":"update","success":true}],"messages":["Completed"],"total":3}}}}}}}}
>
  
</StatusCodes>

---

## Bulk User Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-user-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk User Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple user addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Bulk User Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bulk User Addresses - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Bulk User Addresses - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Bulk User Addresses - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk User Addresses - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk User Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Bulk User Addresses - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroup Addresses

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-usergroup-addresses.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroup Addresses"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/bulk"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create multiple usergroup addresses with a single API request. If an address with the code provided is found, it will be updated, otherwise a new address will be created. If the code is not provided, a new address will be created. When a new address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | yes |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}},"examples":{"Bulk Usergroup Addresses":{"value":{"addresses":[{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bulk Usergroup Addresses - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroup Addresses - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Bulk Usergroup Addresses - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroup Addresses - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Bulk Usergroup Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Bulk Usergroup Addresses - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroups by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-usergroups-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroups by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `id` endpoint, the usergroups are identified by `id`. If a usergroup with such `id` doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single usergroup's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/usergroups#usergroup-lookup-keys), but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `usergroups` (array of usergroup objects) | yes |
| `id` | yes |
| `name` | no |
| `language` | no |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing usergroup that are not empty | array of field names  <br />e.g. name, company etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing usergroup in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]},"usergroups":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":250},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":214}}}}},"example":[{"budget":"N","budgetInherit":"N","company":"","department":"","id":250,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","notes":"Usergroup created from API","office":"","parent":{"id":214}}]}}},"examples":{"Bulk Usergroups by Id":{"value":{"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}],"usergroups":[{"budget":"N","budgetInherit":"N","company":"","department":"","id":250,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","notes":"Usergroup created from API","office":"","parent":{"id":214}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Usergroups by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:44:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9acb5f95-5bfb-4ed9-8a3b-e32c980eb1ce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"id":{"type":"number","example":215},"key":{"type":"number","example":250},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","id":215,"key":250,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroups by Id - 200":{"value":{"data":[{"action":"create","id":215,"key":250,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Usergroups by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:05:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c7e8e727-9ea6-463b-8323-1107f2da55a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/usergroups/0: required key [name] not found"},"example":["#/usergroups/0: required key [name] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroups by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/usergroups/0: required key [name] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Usergroups by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-usergroups-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Usergroups by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk `sourceId` endpoint, the usergroups are identified by `sourceId`, `source` and `language`. If a usergroup doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.

Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single usergroup's attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/users#user-lookup-keys), but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `usergroups` (array of usergroup objects) | yes |
| `source` | yes |
| `sourceId` | yes |
| `name` | no |
| `language` | yes |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

## Directives

| **Name** | **Description** | **Fields** |
| --- | --- | --- |
| `skipIfNotEmpty` | On update, skip updating fields of an existing usergroup that are not empty | array of field names  <br />e.g. name, company etc. |
| `skipMoveOnUpdate` | On update, skip moving an existing usergroup in the parent provided | empty array |

[What are directives?](#directives)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"directives":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{},"example":[]},"operation":{"type":"string","example":"skipMoveOnUpdate"}}},"example":[{"fields":[],"operation":"skipMoveOnUpdate"}]},"usergroups":{"type":"array","items":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}}}},"example":[{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":109}}]}}},"examples":{"Bulk Usergroups by source id":{"value":{"directives":[{"fields":[],"operation":"skipMoveOnUpdate"}],"usergroups":[{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":109}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Usergroups by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"179"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 11:02:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e3e4243-b81d-4fe7-9566-b6844a18daa1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":215},"key":{"type":"number","example":100001},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":215,"key":100001,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Usergroups by source id - 200":{"value":{"data":[{"action":"update","id":215,"key":100001,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Usergroups by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"238"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 11:00:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7aaae2c3-1615-40de-8b9d-9fb94a108d4f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/usergroups/0: required key [sourceId] not found"},"example":["#/usergroups/0: required key [sourceId] not found","#/usergroups/0: required key [id] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Usergroups by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/usergroups/0: required key [sourceId] not found","#/usergroups/0: required key [id] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Users by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-users-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Users by Id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/bulk/id"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `id` endpoint, the products are identified by `id`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single users attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/users#user-lookup-keys), but if it's needed to modify attributes for multiple users, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `users` (array of users) | yes |
| `id` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when sourceId is provided |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14718},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"id":{"type":"number","example":122}}},"phone":{"type":"string","example":"0032445888"},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","gender":"M","id":14718,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":122},"phone":"0032445888","title":"Mr."}]}}},"examples":{"Bulk Users by Id":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","gender":"M","id":14718,"language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"id":122},"phone":"0032445888","title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Users by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:44:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9acb5f95-5bfb-4ed9-8a3b-e32c980eb1ce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":14713},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Users by Id - 200":{"value":{"data":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Users by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:05:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c7e8e727-9ea6-463b-8323-1107f2da55a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/users/0: required key [firstName] not found"},"example":["#/users/0: required key [firstName] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Users by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/users/0: required key [firstName] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Bulk Users by source id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bulk-users-by-source-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bulk Users by source id"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/bulk/sourceId"}
  context={"endpoint"}
>
  
</MethodEndpoint>



The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk `sourceId` endpoint, the users are identified by `sourceId`, `source` and `language`. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go [here](/reference/legacy/rest-v1/attributes).

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go [here](/reference/legacy/rest-v1/pricesheets).

A single users attributes can be modified as explained in [Bulk resource attribute values by resource lookup key](/reference/legacy/rest-v1/users#user-lookup-keys), but if it's needed to modify attributes for multiple users, this endpoint should be used.

## Fields

| **Name** | **Required** |
| --- | --- |
| `users` (array of users) | yes |
| `source` | yes |
| `sourceId` | yes |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `attributes`  <br />  <br />Read [more](/reference/legacy/rest-v1/attributes) about attributes | no |
| `pricing`  <br />  <br />Read [more](/reference/legacy/rest-v1/pricesheets) about pricing | no |
| `addresses`  <br />  <br /> | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"attributes":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"user"},"name":{"type":"string","example":"SHOW_ONACCOUNT"},"type":{"type":"string","example":"enum"},"value":{"type":"string","example":"N"}}},"example":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}]},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"parent":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":200105}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}},"examples":{"Bulk Users by source id":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}},"Search Users":{"value":{"users":[{"abbreviation":"MM","attributes":[{"class":"user","name":"SHOW_ONACCOUNT","type":"enum","value":"N"},{"class":"user","name":"SHOW_PAYPAL","type":"enum","value":"Y"}],"debtorId":12345,"email":"miles@propel.us","gender":"M","language":"NL","lastName":"McCoy","middleName":"","mobile":"0032445888","parent":{"language":"NL","source":"REST-API","sourceId":200105},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bulk Users by source id - 200 / Bulk Users by source id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:39:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"19ec74a0-4079-44b6-ab3b-8ca4d325e268"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"update"},"id":{"type":"number","example":14713},"key":{"type":"number","example":3002196},"lookupKey":{"type":"string","example":"sourceId"},"success":{"type":"boolean","example":true}}},"example":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Bulk Users by source id - 200":{"value":{"data":[{"action":"update","id":14713,"key":3002196,"lookupKey":"sourceId","success":true}],"messages":["Completed"],"total":1}}}}}},"400":{"description":"Bulk Users by source id - 400 (invalid schema) / Bulk Users by source id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 17:59:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"04c2dbfb-985e-4a58-8794-957974360a32"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/users/0: required key [firstName] not found"},"example":["#/users/0: required key [firstName] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Bulk Users by source id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/users/0: required key [firstName] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Add Bundle Items to existing bundle

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/add-bundle-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Add Bundle Items to existing bundle"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/bundles/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Add Bundle Items to existing bundle

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Bundle identifier","example":1234,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Add Bundle Items Input","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"],"nullable":true,"default":"N"}},"required":["productId"],"title":"BundleItemInput"}}},"required":["items"],"title":"BundleAddItemsInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bundle Items added","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}}}},"400":{"description":"Bad request"},"409":{"description":"Bundle Items already exists"},"500":{"description":"Add Bundle Items error"}}}
>
  
</StatusCodes>

---

## Bundles API

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/bundles-api.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 1.9.0"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Bundles API"}
>
</Heading>



Bundles API

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div><div
  style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
  <h3
    style={{"marginBottom":"0.25rem"}}
  >
    Contact
  </h3><span>
    Propeller: [cloud@propel.us](mailto:cloud@propel.us)
  </span><span>
    URL: [https://propeller-commerce.com](https://propeller-commerce.com)
  </span>
</div>

---

## Create a new bundle

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/create-bundle.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a new bundle"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/bundles"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new bundle

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Create Bundle Input","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle."},"discount":{"type":"number","description":"The discount percentage this bundle."},"condition":{"type":"string","enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"type":"number","description":"The bundle prices."},"taxZone":{"type":"string","description":"The bundle tax zone.","default":"NL","example":"NL"},"addBundleItems":{"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"],"nullable":true,"default":"N"}},"required":["productId"],"title":"BundleItemInput"}}},"required":["name","description"],"title":"CreateBundleInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Bundle created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The bundles primary identifier"},"comboId":{"type":"integer","description":"[DEPRECATED] The bundles identifier for Propeller internal use","default":null,"deprecated":true},"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle.","nullable":true},"discount":{"type":"number","nullable":true,"description":"The discount percentage this bundle."},"condition":{"type":"string","nullable":true,"enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"nullable":true,"description":"The bundle prices.","allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"items":{"nullable":true,"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}},"required":["id","name"],"title":"Bundle"}}}},"400":{"description":"Bad request"},"409":{"description":"Bundle already exists"},"500":{"description":"Create bundle error"}}}
>
  
</StatusCodes>

---

## Delete an existing bundle

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/delete-bundle.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete an existing bundle"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/bundles/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete an existing bundle

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Bundle identifier","example":1234,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bundle deleted","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad request"},"404":{"description":"Bundle not found"},"500":{"description":"Delete bundle error"}}}
>
  
</StatusCodes>

---

## Get a bundle by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/get-bundle-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get a bundle by id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/bundles/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get a bundle by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Bundle identifier","example":1234,"schema":{"type":"integer"}},{"name":"taxZone","required":false,"in":"query","description":"Tax zone","schema":{"default":"NL"},"allowEmptyValue":false},{"name":"expands","required":false,"in":"query","schema":{"items":{"type":"string"}},"explode":false,"description":"Expansion flag. Expand the response with oneOf: [`items`]. (comma separated list of values)","allowEmptyValue":false,"example":["items"]}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get a bundle by id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The bundles primary identifier"},"comboId":{"type":"integer","description":"[DEPRECATED] The bundles identifier for Propeller internal use","default":null,"deprecated":true},"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle.","nullable":true},"discount":{"type":"number","nullable":true,"description":"The discount percentage this bundle."},"condition":{"type":"string","nullable":true,"enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"nullable":true,"description":"The bundle prices.","allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"items":{"nullable":true,"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}},"required":["id","name"],"title":"Bundle"}}}},"400":{"description":"Bad request","content":{"application/json":{"examples":{"validationError":{"description":"Validation error","value":{"message":"Please provide valid integer(string encoded) value for id","status":400,"code":20003,"type":"BundleBadRequestError","info":"https://www.propel.us/docs/errors/20003"}}}}}},"403":{"description":"Forbidden."},"404":{"description":"Bundle not found","content":{"application/json":{"examples":{"byId":{"description":"Bundle with provided `id` not found","value":{"message":"Bundle with id '666' not found!","status":404,"code":20002,"type":"BundleNotFoundError","info":"https://www.propel.us/docs/errors/20002"}}}}}},"500":{"description":"Get bundle error"}}}
>
  
</StatusCodes>

---

## List bundles

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/list-bundles.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List bundles"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/bundles"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List bundles

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"taxZone","required":false,"in":"query","description":"Tax zone","schema":{"default":"NL"},"allowEmptyValue":false,"example":"NL"},{"name":"page","required":false,"in":"query","description":"Pagination page number","schema":{"default":1},"allowEmptyValue":false,"example":1},{"name":"offset","required":false,"in":"query","description":"Pagination offset number","schema":{"default":12},"allowEmptyValue":false,"example":12},{"name":"expands","required":false,"in":"query","schema":{"items":{"type":"string"}},"explode":false,"description":"Expansion flag. Expand the response with [`items`]. (comma separated list of values)","allowEmptyValue":false,"example":["items"]}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"List bundles","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type Bundle","type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The bundles primary identifier"},"comboId":{"type":"integer","description":"[DEPRECATED] The bundles identifier for Propeller internal use","default":null,"deprecated":true},"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle.","nullable":true},"discount":{"type":"number","nullable":true,"description":"The discount percentage this bundle."},"condition":{"type":"string","nullable":true,"enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"nullable":true,"description":"The bundle prices.","allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"items":{"nullable":true,"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}},"required":["id","name"],"title":"Bundle"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"BundlesResponse"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden."},"500":{"description":"List bundles error"}}}
>
  
</StatusCodes>

---

## Remove Bundle Item from a bundle

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/remove-bundle-item.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove Bundle Item from a bundle"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/bundles/{id}/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Remove Bundle Item from a bundle

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Bundle identifier","example":1234,"schema":{"type":"integer"}},{"name":"productId","required":true,"in":"path","description":"Product identifier","example":5678,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bundle Item deleted","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad request"},"404":{"description":"Bundle Item not found"},"500":{"description":"Delete Bundle Item error"}}}
>
  
</StatusCodes>

---

## Search bundles by product ids

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/search-bundles-by-product-ids.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search bundles by product ids"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/bundles/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Search bundles by product ids

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","required":false,"in":"query","schema":{"default":1},"description":"Pagination page number","allowEmptyValue":false,"example":1},{"name":"offset","required":false,"in":"query","schema":{"default":12},"description":"Pagination offset number","allowEmptyValue":false,"example":12}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"Product ids to search bundles for","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"taxZone":{"type":"string","description":"Tax zone","default":"NL","example":"NL"}},"required":["productIds"],"title":"SearchBundlesInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search bundles by product ids","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The bundles primary identifier"},"comboId":{"type":"integer","description":"[DEPRECATED] The bundles identifier for Propeller internal use","default":null,"deprecated":true},"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle.","nullable":true},"discount":{"type":"number","nullable":true,"description":"The discount percentage this bundle."},"condition":{"type":"string","nullable":true,"enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"nullable":true,"description":"The bundle prices.","allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"items":{"nullable":true,"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}},"required":["id","name"],"title":"Bundle"}}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden."},"500":{"description":"Search bundles by product ids error"}}}
>
  
</StatusCodes>

---

## Update an existing bundle

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/bundles/update-bundle.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update an existing bundle"}
>
</Heading>

<MethodEndpoint
  method={"put"}
  path={"/v1/bundles/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update an existing bundle

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Bundle identifier","example":1234,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Update Bundle Input","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle."},"discount":{"type":"number","description":"The discount percentage this bundle."},"condition":{"type":"string","enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"type":"number","description":"The bundle prices."},"taxZone":{"type":"string","description":"The bundle tax zone.","default":"NL","example":"NL"}},"title":"UpdateBundleDTO"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Bundle updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The bundles primary identifier"},"comboId":{"type":"integer","description":"[DEPRECATED] The bundles identifier for Propeller internal use","default":null,"deprecated":true},"name":{"type":"string","description":"The name for this bundle."},"description":{"type":"string","description":"The description for this bundle.","nullable":true},"discount":{"type":"number","nullable":true,"description":"The discount percentage this bundle."},"condition":{"type":"string","nullable":true,"enum":["ALL","EP"],"description":"The discount condition for this bundle. Discount can be applied for Extra Products (EP) or All Products (ALL)."},"price":{"nullable":true,"description":"The bundle prices.","allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"items":{"nullable":true,"description":"Items for this bundle.","type":"array","items":{"type":"object","properties":{"productId":{"type":"number","description":"The bundles primary product identifier"},"price":{"description":"Bundle price.","nullable":true,"allOf":[{"type":"object","properties":{"net":{"type":"number","description":"Net price of the bundle after discounts applied"},"gross":{"type":"number","description":"Gross price of the bundle after discounts applied"},"originalNet":{"type":"number","description":"Original net price of the bundle before discounts applied"},"originalGross":{"type":"number","description":"Original gross price of the bundle before discounts applied"}},"title":"BundlePrice"}]},"isLeader":{"type":"string","description":"Indicates whether the product is leader for this bundle.","enum":["Y","N"]}},"required":["productId","isLeader"],"title":"BundleItem"}}},"required":["id","name"],"title":"Bundle"}}}},"400":{"description":"Bad request"},"404":{"description":"Bundle not found"},"409":{"description":"Bundle already exists"},"500":{"description":"Update bundle error"}}}
>
  
</StatusCodes>

---

## Carrier API

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/carrier-api.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 0.7.0"}
></span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Carrier API"}
></Heading>

Comprehensive shipping carrier management API for logistics and delivery operations.

Manage shipping carriers, configure service offerings, handle warehouse assignments, and integrate with logistics systems. Supports full CRUD operations with advanced filtering, pagination, and sorting capabilities.

<div style={{ marginBottom: "2rem" }}>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  ></Heading>
  <SchemaTabs className={"openapi-tabs__security-schemes"}>
    <TabItem label={"OAuth 2.0: OAuth2"} value={"OAuth2"}>
      OAuth2 client credentials flow for API authentication
      <div>
        <table>
          <tbody>
            <tr>
              <th>Security Scheme Type:</th>
              <td>oauth2</td>
            </tr>
            <tr>
              <th>OAuth Flow (clientCredentials):</th>
              <td>
                <div>Token URL: https://api.helice.cloud/oauth2/token/</div>
                <span>Scopes:</span>
                <ul></ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div>
<div
  style={{
    display: "flex",
    flexDirection: "column",
    marginBottom: "var(--ifm-paragraph-margin-bottom)",
  }}
>
  <h3 style={{ marginBottom: "0.25rem" }}>Contact</h3>
  <span>Support Team: [cloud@propel.us](mailto:cloud@propel.us)</span>
  <span>
    URL: [https://propeller-commerce.com](https://propeller-commerce.com)
  </span>
</div>

---

## Create new shipping carrier in the system

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/create-carrier.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create new shipping carrier in the system"}
></Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/carriers"}
  context={"endpoint"}
></MethodEndpoint>

Create a new shipping carrier with service details and configuration.

Establishes a new carrier with service offerings, coverage areas, pricing information, and integration settings. The carrier becomes immediately available for shipping calculations and logistics operations.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
></Heading>

<ParamsDetails
  parameters={[
    {
      name: "tenant",
      in: "header",
      description: "Organization identifier for multi-tenant access control",
      required: true,
      schema: { type: "string" },
    },
  ]}
></ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{
    required: true,
    content: {
      "application/json": {
        schema: {
          type: "object",
          properties: {
            name: {
              type: "string",
              description:
                "Unique name identifying the shipping carrier within your organization",
              example: "DHL Express",
              maxLength: 64,
            },
            type: {
              type: "string",
              description: "Type of shipping service offered by this carrier",
              enum: ["PICKUP", "DELIVERY"],
              example: "DELIVERY",
            },
            descriptions: {
              description:
                "Localized descriptions of the carrier service for different languages and markets",
              example: [
                {
                  language: "EN",
                  value: "Fast and reliable international delivery service",
                },
                {
                  language: "DE",
                  value:
                    "Schneller und zuverlässiger internationaler Lieferservice",
                },
                {
                  language: "NL",
                  value: "Snelle en betrouwbare internationale bezorgservice",
                },
              ],
              type: "array",
              items: {
                type: "object",
                properties: {
                  language: {
                    type: "string",
                    description: "Localized field language code",
                    maxLength: 2,
                    minLength: 2,
                    example: "EN",
                  },
                  value: {
                    type: "string",
                    nullable: true,
                    description: "Localized field value",
                    example: "example value",
                  },
                },
                required: ["language", "value"],
                title: "LocalizedStringInput",
              },
            },
            shippingCost: {
              type: "number",
              description:
                "Deprecated in favor of Propeller's business rule builder, where logic can be set up for carriers and more complex use cases",
              example: 9.99,
              deprecated: true,
            },
            trackAndTraceURL: {
              type: "string",
              description:
                "URL template for package tracking and shipment monitoring",
              format: "uri",
              example:
                "https://www.dhl.com/track?trackingNumber={trackingNumber}",
              maxLength: 255,
            },
            logo: {
              type: "string",
              description:
                "Public URL to the carrier's logo image for branding in shipping interfaces",
              format: "uri",
              example: "https://cdn.example.com/carriers/dhl-express-logo.png",
              maxLength: 255,
            },
            warehouseIds: {
              description:
                "Identifiers of warehouses where this carrier provides shipping services",
              example: [1111, 2222, 3333],
              uniqueItems: true,
              type: "array",
              items: { type: "integer" },
            },
          },
          required: ["name", "type", "shippingCost"],
          title: "CarrierCreateInput",
        },
      },
    },
  }}
></RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{
    "201": {
      description: "Carrier successfully created",
      schema: {
        example: {
          id: 4242,
          name: "DHL Express",
          type: "DELIVERY",
          descriptions: [
            {
              language: "EN",
              value: "Fast and reliable international delivery",
            },
          ],
          shippingCost: 15.99,
          trackAndTraceURL:
            "https://www.dhl.com/track?trackingNumber={trackingNumber}",
          logo: "https://cdn.example.com/carriers/dhl-logo.png",
          warehouses: [1111, 2222],
          createdAt: "2024-01-15T10:30:00.000Z",
          lastModifiedAt: "2024-01-15T10:30:00.000Z",
          createdBy: 1234,
          lastModifiedBy: 1234,
        },
      },
      content: {
        "application/json": {
          schema: {
            type: "object",
            properties: {
              id: {
                type: "integer",
                description: "Unique identifier for the shipping carrier",
                example: 4242,
              },
              name: {
                type: "string",
                description: "Shipping carrier company name",
                example: "DHL Express",
              },
              type: {
                type: "string",
                description: "Type of shipping service offered by the carrier",
                enum: ["PICKUP", "DELIVERY"],
                example: "PICKUP",
              },
              descriptions: {
                description:
                  "Localized carrier descriptions for different languages",
                default: [],
                example: [
                  { language: "NL", value: "Snelle en betrouwbare bezorging" },
                  {
                    language: "DE",
                    value: "Schnelle und zuverlässige Lieferung",
                  },
                  { language: "EN", value: "Fast and reliable delivery" },
                ],
                type: "array",
                items: {
                  type: "object",
                  properties: {
                    language: {
                      type: "string",
                      description:
                        "Language is set as 2 character country code.",
                      maxLength: 2,
                      minLength: 2,
                      example: "EN",
                    },
                    value: {
                      type: "string",
                      description: "Localized field value",
                      example: "example value",
                    },
                  },
                  required: ["language"],
                  title: "LocalizedString",
                },
              },
              shippingCost: {
                type: "number",
                description:
                  "Base shipping cost for this carrier (deprecated in favor of business rule builder)",
                example: 15.99,
                deprecated: true,
                format: "decimal",
              },
              trackAndTraceURL: {
                type: "string",
                description:
                  "Package tracking URL template for shipment monitoring",
                format: "uri",
                example:
                  "https://www.dhl.com/track?trackingNumber={trackingNumber}",
                maxLength: 255,
                nullable: true,
              },
              logo: {
                type: "string",
                description:
                  "Carrier logo URL for branding in shipping options",
                format: "uri",
                example:
                  "https://cdn.example.com/carriers/dhl-express-logo.png",
                maxLength: 255,
                nullable: true,
              },
              warehouses: {
                type: "array",
                description:
                  "Identifiers of warehouses where this carrier provides shipping services",
                example: [1111, 2222, 3333],
                items: { type: "integer", minimum: 1 },
                default: [],
                uniqueItems: true,
              },
              createdAt: {
                format: "date-time",
                type: "string",
                description: "Date and time when the carrier was created",
                example: "2024-01-15T10:30:00.000Z",
              },
              lastModifiedAt: {
                format: "date-time",
                type: "string",
                description: "Date and time when the carrier was last modified",
                example: "2024-01-20T14:45:00.000Z",
              },
              createdBy: {
                type: "integer",
                description: "The userId of the user that created the carrier",
                example: 1234,
              },
              lastModifiedBy: {
                type: "integer",
                description:
                  "The userId of the user that last modified the carrier",
                example: 1234,
              },
            },
            required: [
              "id",
              "name",
              "type",
              "shippingCost",
              "trackAndTraceURL",
              "logo",
              "warehouses",
              "createdAt",
              "lastModifiedAt",
            ],
            title: "Carrier",
          },
        },
      },
    },
    "400": {
      description: "Invalid request data",
      content: {
        "application/json": {
          schema: {
            example: {
              message: "Validation failed: name is required",
              status: 400,
              code: 23000,
              type: "CarrierBadRequestError",
              info: "https://www.propel.us/docs/errors/23000",
            },
          },
        },
      },
    },
    "409": {
      description: "Carrier name already exists",
      content: {
        "application/json": {
          schema: {
            example: {
              message: "Carrier with name 'DHL Express' already exists",
              status: 409,
              code: 23008,
              type: "CarrierAlreadyExistsError",
              info: "https://www.propel.us/docs/errors/23008",
            },
          },
        },
      },
    },
    "500": {
      description: "Internal server error during carrier creation",
      content: {
        "application/json": {
          schema: {
            example: {
              message: "Failed to create carrier in data source",
              status: 500,
              code: 23005,
              type: "CarrierCreateError",
              info: "https://www.propel.us/docs/errors/23005",
            },
          },
        },
      },
    },
  }}
></StatusCodes>

---

## Delete carrier from system

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/delete-carrier.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete carrier from system"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/carriers/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Permanently remove a carrier and all associated configuration.

This action cannot be undone and will affect any shipping operations that depend on this carrier. Ensure the carrier is not actively used before deletion.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"tenant","in":"header","description":"Organization identifier for multi-tenant access control","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier of the carrier to delete","example":4242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Carrier successfully deleted","content":{"application/json":{"schema":{"type":"boolean","example":true}}}},"400":{"description":"Invalid carrier identifier","content":{"application/json":{"schema":{"example":{"message":"Validation failed: id must be a positive integer","status":400,"code":23000,"type":"CarrierBadRequestError","info":"https://www.propel.us/docs/errors/23000"}}}}},"404":{"description":"Carrier not found","content":{"application/json":{"schema":{"example":{"message":"Carrier with id: '999' not found","status":404,"code":23001,"type":"CarrierNotFoundError","info":"https://www.propel.us/docs/errors/23001"}}}}},"500":{"description":"Internal server error during deletion","content":{"application/json":{"schema":{"example":{"message":"Failed to delete carrier from data source","status":500,"code":23004,"type":"CarrierDeleteError","info":"https://www.propel.us/docs/errors/23004"}}}}}}}
>
  
</StatusCodes>

---

## Retrieve carrier by identifier

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/get-carrier.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Retrieve carrier by identifier"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/carriers/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve detailed information about a specific shipping carrier by its unique identifier.

Returns comprehensive carrier data including services, coverage areas, pricing information, and integration settings for shipping configuration and logistics management.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"tenant","in":"header","description":"Organization identifier for multi-tenant access control","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier of the carrier to retrieve","example":4242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Successfully retrieved carrier information","schema":{"example":{"id":4242,"name":"DHL Express","type":"DELIVERY","descriptions":[{"language":"EN","value":"Fast and reliable international delivery"}],"shippingCost":15.99,"trackAndTraceURL":"https://www.dhl.com/track?trackingNumber={trackingNumber}","logo":"https://cdn.example.com/carriers/dhl-logo.png","warehouses":[1111,2222],"createdAt":"2024-01-15T10:30:00.000Z","lastModifiedAt":"2024-01-20T14:45:00.000Z","createdBy":1234,"lastModifiedBy":1234}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the shipping carrier","example":4242},"name":{"type":"string","description":"Shipping carrier company name","example":"DHL Express"},"type":{"type":"string","description":"Type of shipping service offered by the carrier","enum":["PICKUP","DELIVERY"],"example":"PICKUP"},"descriptions":{"description":"Localized carrier descriptions for different languages","default":[],"example":[{"language":"NL","value":"Snelle en betrouwbare bezorging"},{"language":"DE","value":"Schnelle und zuverlässige Lieferung"},{"language":"EN","value":"Fast and reliable delivery"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"shippingCost":{"type":"number","description":"Base shipping cost for this carrier (deprecated in favor of business rule builder)","example":15.99,"deprecated":true,"format":"decimal"},"trackAndTraceURL":{"type":"string","description":"Package tracking URL template for shipment monitoring","format":"uri","example":"https://www.dhl.com/track?trackingNumber={trackingNumber}","maxLength":255,"nullable":true},"logo":{"type":"string","description":"Carrier logo URL for branding in shipping options","format":"uri","example":"https://cdn.example.com/carriers/dhl-express-logo.png","maxLength":255,"nullable":true},"warehouses":{"type":"array","description":"Identifiers of warehouses where this carrier provides shipping services","example":[1111,2222,3333],"items":{"type":"integer","minimum":1},"default":[],"uniqueItems":true},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was created","example":"2024-01-15T10:30:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was last modified","example":"2024-01-20T14:45:00.000Z"},"createdBy":{"type":"integer","description":"The userId of the user that created the carrier","example":1234},"lastModifiedBy":{"type":"integer","description":"The userId of the user that last modified the carrier","example":1234}},"required":["id","name","type","shippingCost","trackAndTraceURL","logo","warehouses","createdAt","lastModifiedAt"],"title":"Carrier"}}}},"400":{"description":"Invalid carrier identifier","content":{"application/json":{"schema":{"example":{"message":"Validation failed: id must be a positive integer","status":400,"code":23000,"type":"CarrierBadRequestError","info":"https://www.propel.us/docs/errors/23000"}}}}},"403":{"description":"Insufficient permissions to access carrier information","content":{"application/json":{"schema":{"example":{"message":"Access denied: insufficient permissions","status":403,"code":23007,"type":"CarrierForbiddenError","info":"https://www.propel.us/docs/errors/23007"}}}}},"404":{"description":"Carrier not found","content":{"application/json":{"examples":{"byId":{"description":"Carrier with provided `id` not found","value":{"message":"Carrier with id: '666' not found!","status":404,"code":23001,"type":"CarrierNotFoundError","info":"https://www.propel.us/docs/errors/23001"}}}}}},"500":{"description":"Internal server error during carrier retrieval","content":{"application/json":{"schema":{"example":{"message":"Failed to retrieve carrier from data source","status":500,"code":23002,"type":"CarrierGetError","info":"https://www.propel.us/docs/errors/23002"}}}}}}}
>
  
</StatusCodes>

---

## Retrieve shipping carriers with filtering and pagination

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/list-carriers.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Retrieve shipping carriers with filtering and pagination"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/carriers"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve a paginated list of shipping carriers with comprehensive filtering capabilities for logistics management.

Supports filtering by creation dates, identifiers, and sorting options. Results include carrier details, service offerings, and operational status for shipping configuration and management.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"tenant","in":"header","description":"Organization identifier for multi-tenant access control","required":true,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number for pagination results","allowEmptyValue":false,"example":1,"schema":{"minimum":1,"default":1}},{"name":"offset","required":false,"in":"query","description":"Number of items per page","allowEmptyValue":false,"example":12,"schema":{"minimum":1,"maximum":100,"default":12}},{"name":"createdAtGreaterThan","required":false,"in":"query","description":"Filter carriers created after this date (ISO 8601 format)","allowEmptyValue":false,"example":"2024-01-15T10:30:00.000Z","schema":{"type":"string"}},{"name":"createdAtLessThan","required":false,"in":"query","description":"Filter carriers created before this date (ISO 8601 format)","allowEmptyValue":false,"example":"2024-12-31T23:59:59.999Z","schema":{"type":"string"}},{"name":"lastModifiedAtGreaterThan","required":false,"in":"query","description":"Filter carriers modified after this date (ISO 8601 format)","allowEmptyValue":false,"example":"2024-01-15T10:30:00.000Z","schema":{"type":"string"}},{"name":"lastModifiedAtLessThan","required":false,"in":"query","description":"Filter carriers modified before this date (ISO 8601 format)","allowEmptyValue":false,"example":"2024-12-31T23:59:59.999Z","schema":{"type":"string"}},{"name":"ids","required":false,"in":"query","description":"Filter by specific carrier identifiers","allowEmptyValue":false,"example":[1111,2222,3333],"schema":{"type":"array","items":{"type":"number"}}},{"name":"sortField","required":false,"in":"query","description":"Field to sort results by","allowEmptyValue":false,"example":"name","schema":{"default":"id","enum":["id","name","lastModifiedAt","createdAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort direction for results","allowEmptyValue":false,"example":"asc","schema":{"default":"asc","enum":["asc","desc","asc","desc"],"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Successfully retrieved paginated list of carriers matching the search criteria","schema":{"example":{"items":[{"id":4242,"name":"DHL Express","type":"DELIVERY","descriptions":[{"language":"EN","value":"Fast and reliable international delivery"}],"shippingCost":15.99,"trackAndTraceURL":"https://www.dhl.com/track?trackingNumber={trackingNumber}","logo":"https://cdn.example.com/carriers/dhl-logo.png","warehouses":[1111,2222],"createdAt":"2024-01-15T10:30:00.000Z","lastModifiedAt":"2024-01-20T14:45:00.000Z","createdBy":1234,"lastModifiedBy":1234}],"itemsFound":1,"page":1,"offset":12,"hasNextPage":false,"hasPreviousPage":false}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of carriers matching the search criteria","example":[{"id":4242,"name":"DHL Express","type":"DELIVERY","descriptions":[{"language":"EN","value":"Fast and reliable international delivery"}],"shippingCost":15.99,"trackAndTraceURL":"https://www.dhl.com/track?id={trackingNumber}","logo":"https://cdn.example.com/carriers/dhl-logo.png","warehouseIds":[1111,2222],"createdAt":"2024-01-15T10:30:00.000Z","lastModifiedAt":"2024-01-20T14:45:00.000Z"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the shipping carrier","example":4242},"name":{"type":"string","description":"Shipping carrier company name","example":"DHL Express"},"type":{"type":"string","description":"Type of shipping service offered by the carrier","enum":["PICKUP","DELIVERY"],"example":"PICKUP"},"descriptions":{"description":"Localized carrier descriptions for different languages","default":[],"example":[{"language":"NL","value":"Snelle en betrouwbare bezorging"},{"language":"DE","value":"Schnelle und zuverlässige Lieferung"},{"language":"EN","value":"Fast and reliable delivery"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"shippingCost":{"type":"number","description":"Base shipping cost for this carrier (deprecated in favor of business rule builder)","example":15.99,"deprecated":true,"format":"decimal"},"trackAndTraceURL":{"type":"string","description":"Package tracking URL template for shipment monitoring","format":"uri","example":"https://www.dhl.com/track?trackingNumber={trackingNumber}","maxLength":255,"nullable":true},"logo":{"type":"string","description":"Carrier logo URL for branding in shipping options","format":"uri","example":"https://cdn.example.com/carriers/dhl-express-logo.png","maxLength":255,"nullable":true},"warehouses":{"type":"array","description":"Identifiers of warehouses where this carrier provides shipping services","example":[1111,2222,3333],"items":{"type":"integer","minimum":1},"default":[],"uniqueItems":true},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was created","example":"2024-01-15T10:30:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was last modified","example":"2024-01-20T14:45:00.000Z"},"createdBy":{"type":"integer","description":"The userId of the user that created the carrier","example":1234},"lastModifiedBy":{"type":"integer","description":"The userId of the user that last modified the carrier","example":1234}},"required":["id","name","type","shippingCost","trackAndTraceURL","logo","warehouses","createdAt","lastModifiedAt"],"title":"Carrier"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"CarriersResponse"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"example":{"message":"Validation failed: page must be a positive integer","status":400,"code":23000,"type":"CarrierBadRequestError","info":"https://www.propel.us/docs/errors/23000"}}}}},"403":{"description":"Insufficient permissions to access carriers","content":{"application/json":{"schema":{"example":{"message":"Access denied: insufficient permissions","status":403,"code":23007,"type":"CarrierForbiddenError","info":"https://www.propel.us/docs/errors/23007"}}}}},"500":{"description":"Internal server error during carrier retrieval","content":{"application/json":{"schema":{"example":{"message":"Failed to retrieve carriers from data source","status":500,"code":23006,"type":"CarrierInternalServerError","info":"https://www.propel.us/docs/errors/23006"}}}}}}}
>
  
</StatusCodes>

---

## Update existing carrier configuration

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/carriers/update-carrier.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update existing carrier configuration"}
>
</Heading>

<MethodEndpoint
  method={"put"}
  path={"/v1/carriers/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Modify carrier details including service offerings, pricing, and operational settings.

Updates carrier information while maintaining data integrity and business rules. All fields are optional and only provided values will be updated.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"tenant","in":"header","description":"Organization identifier for multi-tenant access control","required":true,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unique identifier of the carrier to update","example":4242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique name identifying the shipping carrier within your organization","example":"DHL Express","maxLength":64},"type":{"type":"string","description":"Type of shipping service offered by this carrier","enum":["PICKUP","DELIVERY"],"example":"DELIVERY"},"descriptions":{"description":"Localized descriptions of the carrier service for different languages and markets","example":[{"language":"EN","value":"Fast and reliable international delivery service"},{"language":"DE","value":"Schneller und zuverlässiger internationaler Lieferservice"},{"language":"NL","value":"Snelle en betrouwbare internationale bezorgservice"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"shippingCost":{"type":"number","description":"Deprecated in favor of Propeller's business rule builder, where logic can be set up for carriers and more complex use cases","example":9.99,"deprecated":true},"trackAndTraceURL":{"type":"string","description":"URL template for package tracking and shipment monitoring","format":"uri","example":"https://www.dhl.com/track?trackingNumber={trackingNumber}","maxLength":255},"logo":{"type":"string","description":"Public URL to the carrier's logo image for branding in shipping interfaces","format":"uri","example":"https://cdn.example.com/carriers/dhl-express-logo.png","maxLength":255},"warehouseIds":{"description":"Identifiers of warehouses where this carrier provides shipping services","example":[1111,2222,3333],"uniqueItems":true,"type":"array","items":{"type":"integer"}}},"title":"UpdateCarrierDTO"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Carrier successfully updated","schema":{"example":{"id":4242,"name":"DHL Express","type":"DELIVERY","descriptions":[{"language":"EN","value":"Fast and reliable international delivery"},{"language":"DE","value":"Schnelle und zuverlässige internationale Lieferung"}],"shippingCost":15.99,"trackAndTraceURL":"https://www.dhl.com/track?trackingNumber={trackingNumber}","logo":"https://cdn.example.com/carriers/dhl-logo.png","warehouses":[1111,2222],"createdAt":"2024-01-15T10:30:00.000Z","lastModifiedAt":"2024-01-20T14:45:00.000Z","createdBy":1234,"lastModifiedBy":1234}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the shipping carrier","example":4242},"name":{"type":"string","description":"Shipping carrier company name","example":"DHL Express"},"type":{"type":"string","description":"Type of shipping service offered by the carrier","enum":["PICKUP","DELIVERY"],"example":"PICKUP"},"descriptions":{"description":"Localized carrier descriptions for different languages","default":[],"example":[{"language":"NL","value":"Snelle en betrouwbare bezorging"},{"language":"DE","value":"Schnelle und zuverlässige Lieferung"},{"language":"EN","value":"Fast and reliable delivery"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"shippingCost":{"type":"number","description":"Base shipping cost for this carrier (deprecated in favor of business rule builder)","example":15.99,"deprecated":true,"format":"decimal"},"trackAndTraceURL":{"type":"string","description":"Package tracking URL template for shipment monitoring","format":"uri","example":"https://www.dhl.com/track?trackingNumber={trackingNumber}","maxLength":255,"nullable":true},"logo":{"type":"string","description":"Carrier logo URL for branding in shipping options","format":"uri","example":"https://cdn.example.com/carriers/dhl-express-logo.png","maxLength":255,"nullable":true},"warehouses":{"type":"array","description":"Identifiers of warehouses where this carrier provides shipping services","example":[1111,2222,3333],"items":{"type":"integer","minimum":1},"default":[],"uniqueItems":true},"createdAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was created","example":"2024-01-15T10:30:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Date and time when the carrier was last modified","example":"2024-01-20T14:45:00.000Z"},"createdBy":{"type":"integer","description":"The userId of the user that created the carrier","example":1234},"lastModifiedBy":{"type":"integer","description":"The userId of the user that last modified the carrier","example":1234}},"required":["id","name","type","shippingCost","trackAndTraceURL","logo","warehouses","createdAt","lastModifiedAt"],"title":"Carrier"}}}},"400":{"description":"Invalid request data","content":{"application/json":{"schema":{"example":{"message":"Validation failed: trackAndTraceURL must be a valid HTTPS URL","status":400,"code":23000,"type":"CarrierBadRequestError","info":"https://www.propel.us/docs/errors/23000"}}}}},"404":{"description":"Carrier not found","content":{"application/json":{"schema":{"example":{"message":"Carrier with id: '999' not found","status":404,"code":23001,"type":"CarrierNotFoundError","info":"https://www.propel.us/docs/errors/23001"}}}}},"409":{"description":"Carrier name already exists","content":{"application/json":{"schema":{"example":{"message":"Carrier with name 'DHL Express' already exists","status":409,"code":23008,"type":"CarrierAlreadyExistsError","info":"https://www.propel.us/docs/errors/23008"}}}}},"500":{"description":"Internal server error during update","content":{"application/json":{"schema":{"example":{"message":"Failed to update carrier in data source","status":500,"code":23003,"type":"CarrierUpdateError","info":"https://www.propel.us/docs/errors/23003"}}}}}}}
>
  
</StatusCodes>

---

## Categories

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/categories.tag

<LegacyBanner />



Categories are used in order to organize your product catalogue within your e-commerce platform. They work as hierarchical levels of product classification. There are no limits to the number of levels of categories, though it is recommended not to use too many levels. One product can belong to only one category. The same applies to categories, a category can have only one parent category.

## Category Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller category id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `names` | Category name | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `descriptions` | Category description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `shortDescriptions` | Category short description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `language` | Category default language. | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent category. | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `sourceId` | External system unique id | string |
| `source` | External system | string |
| `metadataTitles` | Metadata title | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataDescriptions` | Metadata description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataKeywords` | Metadata keywords | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataCanonicalUrls` | Metadata canonical URL | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |

## Category Errors

This section describes error codes specific for the `Category` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `30004` | CategoryExists | 400 | Category already exists | Category with such lookup key already exists |
| `30005` | CategoryMultipleFound | 400 | Multuple categories found. Please provide additional filters | Multiple categories with such lookup key exist |
| `30006` | CategoryNotFound | 404 | Category does not exist | Category with such lookup key not found |
| `30007` | ParentCategoryNotFound | 404 | Parent category not found | Parent category with such lookup key not found. This error is typical when working with category sub-resources (e.g. attributes) |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/cluster-config.tag

<LegacyBanner />



Cluster configs are used as rules on how to organize and group your products into clusters within your e-commerce platform. There can be normal clusters for example where there is no need to define attribute, but there can be linear or complex clusters, where you need to define one or two attributes that will be used to group the products.

## Cluster Config Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller cluster config id, auto-generated |
| `name` | string | Cluster config name |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | Cluster config name | string (only alphanumeric characters combined with underscore) |
| `settings` | Cluster config settings | array |

## Settings

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `attributeName` | Setting attribute name | string |
| `displayType` | Setting display type | enum  <br />\- dropdown  <br />\- radio  <br />\- image  <br />\- color |
| `priority` | Setting priority | integer |

## Cluster Config Errors

This section describes error codes specific for the `ClusterConfig` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `21004` | ClusterConfigExists | 400 | Cluster Config already exists | Cluster config with such name already exists |
| `21005` | ClusterConfigNotFound | 404 | Cluster Config does not exist | Cluster config with such lookup key not found |
| `21006` | ClusterConfigSettingExists | 400 | Cluster Config Setting already exists | Cluster config setting with such attribute name already exists |
| `21007` | ClusterConfigSettingNotFound | 404 | Cluster Config Setting does not exist | Cluster config setting with such lookup key not found |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Clusters

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/clusters.tag

<LegacyBanner />



Clusters are groups of products and/or options in an e-commerce shop on the Propeller platform. The Cluster API can be used to consult, create, update or delete a Cluster, Cluster Option or Cluster Product.

## Cluster Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller cluster id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `clusterConfigId` | Cluster config id | integer |
| `sourceId` | External system unique id | string |
| `source` | External system | string |
| `language` | Cluster default language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `code` | Cluster code | string |
| `names` | Cluster name | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `descriptions` | Cluster description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `shortDescriptions` | Cluster short description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `parent` | Parent category | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `metadataTitles` | Metadata title | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataDescriptions` | Metadata description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataKeywords` | Metadata keywords | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataCanonicalUrls` | Metadata canonical URL | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `priority` | Sort clusters based on the priority in search results | integer |

## Cluster Errors

This section describes error codes specific for the `Cluster` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `20004` | ClusterExists | 400 | Cluster already exists | Cluster with such lookup key already exists |
| `20005` | ClusterMultipleFound | 400 | Multiple clusters found. Please provide additional filters | Multiple clusters with such lookup key exist |
| `20006` | ClusterNotFound | 404 | Cluster does not exist | Cluster with such lookup key not found |
| `20007` | ParentClusterNotFound | 404 | Parent cluster not found | Parent cluster with such lookup key not found. |
| `20008` | ClusterNotAllowed | 405 | Cluster is not allowed | No permission for the cluster |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Companies

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/companies.tag

<LegacyBanner />



Companies are used to group contacts from the same company together. This parent - child relationship i.e. tree organizational structure is very powerful because it allows inheriting addresses, settings, permissions, pricing, etc. A usergroup was used to represent a company in a B2B environment, but that concept will soon be deprecated and a dedicated `Companies` resource should be used. Usergroups can still be used to group Companies.

> The company API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API 
  

## Company Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `company` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | Company name | string |
| `language` | Default system language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `taxNumber` | Company tax number | string |
| `cocNumber` | Chamber of commerce number | string |
| `debtorId` | A unique id representing the company | integer  <br />string  <br /> |
| `phone` | Company phone number | string |
| `email` | Company email address | string |
| `department` | Department | string |
| `office` | Office | string |
| `notes` | Notes | string |
| `inheritProductList` | Indicates whether pricing should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `inheritOrderList` | Indicates whether the order list should be inherited from the parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `budget` | Company budget settings | enum  <br />  <br />`Y` = Contacts in the company use budget and may only order products within budget  <br />  <br />`H` = Contacts in the company use budget and may also order products outside budget  <br />  <br />`N` = Contacts in the company do not use budgets |
| `budgetInherit` | Indicates whether budget settings should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `orderListAllowAll` | Order list settings | enum  <br />  <br />`N` = Order everything within the order list  <br />`Y` = Order everything outside the order list  <br />`A` = Order everything, but products outside the order list must be authorized  <br />`U` = Order everything  <br />`P` = Order restricted products |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Company Errors

This section describes error codes specific for the `Company` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `40004` | CompanyExists | 400 | Company already exists | Company with such lookup key already exists |
| `40005` | CompanyMultipleFound | 400 | Multiple companies found. Please provide additional filters | Multiple companies with such lookup key exist |
| `40006` | CompanyNotFound | 404 | Company does not exist | Company with such lookup key not found |
| `40007` | ParentCompanyNotFound | 404 | Parent company not found | Parent company with such lookup key not found. This error is typical when working with company sub-resources (e.g. attributes, addresses) |
| `40008` | CompanyNotAllowed | 405 | Company is not allowed | Usually when company is in Recycle Bin and can't be used |
| `90006` | AddressNotFound | 404 | Address does not exist | Company address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Contacts

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/contacts.tag

<LegacyBanner />



Contacts represent data about a specific customer. Carts, orders, attributes are associated with contacts.

In a B2B environment a contact is part of a `company` representing the organisation he/she is working for. Orders for the company, in a B2B environment, are placed by a specific contact.

> The contact API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API 
  

## Contact Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `contact` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `debtorId` (deprecated) | A unique id representing the company of this contact. A debtorId can be automatically generated by Propellor | integer  <br />string  <br /> |
| `firstName` | Contact first name | string |
| `middleName` | Contact middle name | string |
| `lastName` | Contact last name | string |
| `abbreviation` | Contact abbreviation | string |
| `title` | Contact title | string |
| `dateOfBirth` | Contact date of birth | date |
| `gender` | Contact gender | enum  <br />  <br />**m**\=Male  <br />**f**\=Female  <br />**u**\=Undefined |
| `ssn` | Contact ssn | string |
| `phone` | Contact phone number | string |
| `email` | A valid email address | string |
| `parent` | Parent company | JSON object that identifies the parent. `id` or `sourceId` in combination with source |
| `pricelistAmount` | A `pricesheet` code in case of special pricing agreements | string |
| `pricelistPercentage` | A `pricesheet` code in case of special pricing agreements | string |
| `primaryLanguage` | Contact primary language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## User Errors

This section describes error codes specific for the `User` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `50004` | ContactExists | 400 | Contactalready exists | Contact with such lookup key already exists |
| `50005` | ContactMultipleFound | 400 | Multuple contacts found. Please provide additional filters | Multiple contacts with such lookup key exist |
| `50006` | ContactNotFound | 404 | Contactdoes not exist | Contact with such lookup key not found |
| `50007` | ParentContactNotFound | 404 | Parent contact not found | Parent contact with such lookup key not found. This error is typical when working with contact sub-resources (e.g. attributes) |
| `50008` | ContactNotAllowed | 404 | Contact is not allowed | Usually when contact is in Recycle Bin and can't be used |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Create attribute

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-attribute.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create attribute"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Before setting an attribute value for a specific resource, the attribute definition needs to be created. This endpoint is used to create a single attribute definition.

If an attribute is successfully created, the response will include the attribute `id.`

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | yes |
| `class` | yes |
| `isPublic` | no  <br />Default value is `true` |
| `isSearchable` | no  <br />Default value is `false` |
| `isSystem` | no  <br />Default value is `false` |
| `isHidden` | no  <br />Default value is `false` |
| `type` | yes |
| `typeParam` | only when `type` value is `enum` or `enumlist` |
| `descriptions` | no |
| `value` | only when `type` is `integer`, `decimal`, `date` or `datetime` |
| `units` | no |
| `group` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"value":{"type":"string","example":""}}},"examples":{"Create attribute":{"value":{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create product enum attribute - 201 / Create product text attribute - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"389"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:11:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"02996d01-6320-4efc-bdb4-808e3841ab8c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"value":{"example":"","anyOf":[{"type":"string","example":""},{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""},{"language":"EN","value":""}]}]}}},"messages":{"type":"array","items":{"type":"string","example":"Attribute created"},"example":["Attribute created"]},"total":{"type":"number","example":1}}},"examples":{"Create product enum attribute - 201":{"value":{"data":{"class":"product","descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","value":""},"messages":["Attribute created"],"total":1}},"Create product text attribute - 201":{"value":{"data":{"class":"product","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":669,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","value":[{"language":"NL","value":""},{"language":"EN","value":""}]},"messages":["Attribute created"],"total":1}}}}}},"400":{"description":"Create product text attribute - 400 (invalid value) / Create product enum attribute - 400 (duplicate name)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:13:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a7b7ccff-f72e-49cd-aec2-f3e946dbf060"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/type: text is not a valid enum value"},"example":["#/type: text is not a valid enum value","#/value: expected type: JSONArray, found: String","#/type: text is not a valid enum value","#/value: expected type: Integer, found: String","#/type: text is not a valid enum value","#/value: expected type: Number, found: String","#/type: text is not a valid enum value","#/value: string [] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/type: text is not a valid enum value","#/value: string [] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create product enum attribute - 400 (duplicate name)":{"value":{"error":{"code":14003,"messages":["Attribute with name [COLOR] already exists."],"moreInfo":"https://www.propel.us/docs/errors/14003","status":400,"type":"AttributeExists"}}},"Create product text attribute - 400 (invalid value)":{"value":{"error":{"code":10007,"messages":["#/type: text is not a valid enum value","#/value: expected type: JSONArray, found: String","#/type: text is not a valid enum value","#/value: expected type: Integer, found: String","#/type: text is not a valid enum value","#/value: expected type: Number, found: String","#/type: text is not a valid enum value","#/value: string [] does not match pattern [12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","#/type: text is not a valid enum value","#/value: string [] does not match pattern ([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T(0[1-9]|1[\\d]|2[0-3]):(0[\\d]|[1-5][\\d]):(0[\\d]|[1-5][\\d]))$"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Category

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-category.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Category"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/categories"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single category. If a category is successfully created, the response will include the category `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | yes |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | yes |
| `parent` | yes |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"language":{"type":"string","example":"NL"},"name":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"examples":{"Create Category":{"value":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"language":"NL","name":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Category - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"365"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 08:56:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b29dbca8-6be3-4ef2-a1e1-7fd289adad73"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1771},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"messages":{"type":"array","items":{"type":"string","example":"Category created"},"example":["Category created"]},"total":{"type":"number","example":1}}},"examples":{"Create Category - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1771,"language":"NL","names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"},"messages":["Category created"],"total":1}}}}}},"400":{"description":"Create Category - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 08:57:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b280cd08-4545-4606-9c43-5030888faa13"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: required key [names] not found"},"example":["#: required key [names] not found","#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Category - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: required key [names] not found","#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clustersconfig/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | yes |
| `settings` | no |

## Settings

| **Name** | **Required** |
| --- | --- |
| `attributeName` | yes |
| `displayType` | yes |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR111"},"displayType":{"type":"string","example":"color"},"priority":{"type":"number","example":1}}},"example":[{"attributeName":"PROPELLER_COLOR111","displayType":"color","priority":1}]}}},"examples":{"Create Cluster Config":{"value":{"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR111","displayType":"color","priority":1}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster Config - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"206"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:23:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"9ffed010-ae3b-48d6-87a5-a36ec3d6a323"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"color"},"id":{"type":"number","example":115},"priority":{"type":"number","example":1}}},"example":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":1}]}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config created"},"example":["Cluster Config created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Config - 201":{"value":{"data":{"id":11,"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":1}]},"messages":["Cluster Config created"],"total":1}}}}}},"400":{"description":"Create Cluster Config - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"222"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:24:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"12f3598c-627c-4791-9384-3b20c3e6a83a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21004},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."},"example":["Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"ClusterConfigExists"}}}}},"examples":{"Create Cluster Config - 400":{"value":{"error":{"code":21004,"messages":["Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."],"moreInfo":"https://www.propel.us/docs/errors/21004","status":400,"type":"ClusterConfigExists"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster Option

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-cluster-option.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster Option"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/options"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `isRequired` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"89"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"examples":{"Create Cluster Option":{"value":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster Option - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:34:01 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"76e88d05-5fb9-4fe6-90d1-6e2ec0c21f14"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"id":{"type":"number","example":214},"isRequired":{"type":"string","example":"N"},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option created"},"example":["Cluster Option created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Option - 201":{"value":{"data":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"id":214,"isRequired":"N","language":"NL","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},"messages":["Cluster Option created"],"total":1}}}}}},"404":{"description":"Create Cluster Option - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:35:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"326e0985-904b-4193-b3ba-a9ecf6e29ec1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [215] not found"},"example":["Parent Cluster with id [215] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Create Cluster Option - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [215] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Cluster

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-cluster.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Cluster"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `parent` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `clusterConfigId` | yes |
| `code` | no |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"sku":{"type":"string","example":"15120300"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"15120300"}}},"examples":{"Create Cluster":{"value":{"clusterConfigId":11,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"language":"NL","names":[{"language":"NL","value":"Balpen Slider XB extra"}],"parent":{"id":23409},"sku":"15120300","source":"REST-API","sourceId":"15120300"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Cluster - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"426"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:17:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c5864837-c3a7-46e9-9058-f29b8589d6f7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"15120300"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"id":{"type":"number","example":210},"language":{"type":"string","example":"NL"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"15120300"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster created"},"example":["Cluster created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster - 201":{"value":{"data":{"clusterConfigId":11,"code":"15120300","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"id":210,"language":"NL","names":[{"language":"NL","value":"Balpen Slider XB extra"}],"parent":{"id":23409},"source":"REST-API","sourceId":"15120300"},"messages":["Cluster created"],"total":1}}}}}},"400":{"description":"Create Cluster - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:18:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"75a3a020-8e41-4b1b-9e7e-e5ba0878cb13"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [sku] is not permitted"},"example":["#: extraneous key [sku] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Cluster - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [sku] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Company Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-company-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Company Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a company. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"U"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create Company Address":{"value":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"U","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Company Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"435"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:50:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"d256d03e-fede-4805-95d4-f471102c6f12"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106076},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create Company Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":106076,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create Company Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:51:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"6222e57f-cdc2-457e-b60f-cc6cf823dda3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Company Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Company Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:50:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"2d5c8465-b685-4991-b97e-208888998e41"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Create Company Address - 404":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Company Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-company-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Company Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing company. The company can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific company and all contacts in that company. If a contact in that company already has pricing defined, the price set on the parent company will be ignored.

If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The company will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for contacts in a given company.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1797},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":77138},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create Company Pricing":{"value":{"categories":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Company Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"238"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:24:21 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3e91bd07-65a7-47f5-ac76-f236b6c7ee09"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Company Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}],"messages":["Completed"],"total":3}}}}}},"404":{"description":"Create Company Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"193"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:25:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"cd3e6cdd-5a9b-45ca-b916-0c9b7216c1a5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Create Company Pricing - 404":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Company

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-company.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Company"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single company. If a company is successfully created, the response will include the usergroup `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | no |
| `language` | no |
| `parent` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `debtorId` | no |
| `phone` | no |
| `email` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"number","example":75564998},"debtorId":{"type":"string","example":"75564998"},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Company created from API"},"parent":{"type":"object","properties":{"id":{"type":"number","example":209}}},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"examples":{"Create Company":{"value":{"budget":"N","budgetInherit":"N","cocNumber":75564998,"debtorId":"75564998","inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Company created from API","parent":{"id":209},"taxNumber":"NL860325386B01"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Company - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"291"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:11:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"d1d3515f-44c3-4065-ae98-3cf2e42a5ef6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"debtorId":{"type":"string","example":"75564998"},"id":{"type":"number","example":151},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Company created from API"},"parent":{"type":"object","properties":{"id":{"type":"number","example":209}}},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"messages":{"type":"array","items":{"type":"string","example":"Company created"},"example":["Company created"]},"total":{"type":"number","example":1}}},"examples":{"Create Company - 201":{"value":{"data":{"budget":"N","budgetInherit":"N","cocNumber":"75564998","debtorId":"75564998","id":151,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Propeller B.V.","notes":"Company created from API","parent":{"id":209},"taxNumber":"NL860325386B01"},"messages":["Company created"],"total":1}}}}}},"400":{"description":"Create Company - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"193"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:12:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"61d414b1-19c0-4fe8-9ab4-84a869e3c637"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/cocNumber: expected type: String, found: Integer"},"example":["#/cocNumber: expected type: String, found: Integer"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Company - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/cocNumber: expected type: String, found: Integer"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Contact Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-contact-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Contact Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/contacts/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing contact. The contact can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific contact of the company.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The contact will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single contact.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25492"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1797},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":77138},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create Contact Pricing":{"value":{"categories":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Contact Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"238"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:17:12 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b1b5eb83-c843-4ced-af33-d4b9f7636afe"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Contact Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}],"messages":["Completed"],"total":3}}}}}},"404":{"description":"Create Contact Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:17:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c3d43e11-9e16-4a65-be21-ec8fb27b95e0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":50007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Contact] with id [25494] not found"},"example":["Parent resource [Contact] with id [25494] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentContactNotFound"}}}}},"examples":{"Create Contact Pricing - 404":{"value":{"error":{"code":50007,"messages":["Parent resource [Contact] with id [25494] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentContactNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Contact

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-contact.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Contact"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/contacts/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single contact. If a contact is successfully created, the response will include the user `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `debtorId` (deprecated) | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `ssn` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"company":{"type":"string","example":"Propeller"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":9482}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Create Contact":{"value":{"abbreviation":"MM","company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Contact - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"401"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:28:32 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"35dec49c-b118-433f-b208-8a5c68f62835"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25492},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":9482}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"Contact created"},"example":["Contact created"]},"total":{"type":"number","example":1}}},"examples":{"Create Contact - 201":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25492,"language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["Contact created"],"total":1}}}}}},"400":{"description":"Create Contact - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:29:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"7c6ced8e-1698-4fa5-b6a9-ab5949ff5bfd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [company] is not permitted"},"example":["#: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Contact - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Customer Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-customer-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Customer Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a customer. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"isDefault":{"type":"string","example":"U"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create Customer Address":{"value":{"city":"Arnhem","code":"11234","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","isDefault":"U","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Customer Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"416"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:01:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"02c92970-55a2-49bd-9f8b-612343228fba"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106099},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create Customer Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":106099,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create Customer Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:02:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3716b59f-af0c-429d-ad5a-6368c3a1d7eb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Customer Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Customer Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:02:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"6b5273ca-1e15-4cbb-a4bd-f4e3d1adfaf1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Create Customer Address - 404":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Customer Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-customer-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Customer Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing customer. The customer can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific customer.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The customer will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single customer.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1797},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":77138},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create Customer Pricing":{"value":{"categories":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":86011,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Customer Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"238"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:49:32 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"652b583a-9d38-439e-9512-ba73976d4305"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Customer Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","key":86011,"lookupKey":"id","success":true}],"messages":["Completed"],"total":3}}}}}},"404":{"description":"Create Customer Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:49:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"d0d65f0f-a8fa-4deb-8215-f28ae00c6b72"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [25496] not found"},"example":["Parent resource [User] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Create Customer Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Customer

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-customer.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Customer"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single customer. If a customer is successfully created, the response will include the user `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `abbreviation` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `ssn` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"company":{"type":"string","example":"Propeller"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3004196},"title":{"type":"string","example":"Mr."}}},"examples":{"Create Customer":{"value":{"abbreviation":"MM","company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":109},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3004196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Customer - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"401"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:35:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"34f1ccb0-7a31-4819-b3b0-28bac1ab8f9c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25494},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"EN"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3004196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"Customer created"},"example":["Customer created"]},"total":{"type":"number","example":1}}},"examples":{"Create Customer - 201":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25494,"language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":109},"phone":"0032445888","primaryLanguage":"EN","source":"REST-API","sourceId":3004196,"title":"Mr."},"messages":["Customer created"],"total":1}}}}}},"400":{"description":"Create Customer - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:36:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3c34f1ba-0ae2-47b7-8640-388a7591bcd4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [company] is not permitted"},"example":["#: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Customer - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Option Product

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-option-product.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Option Product"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/clusters/{lookupKey}/{lookupValue}/products"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id 
  

Use this endpoint to create a single product to the option. If a option product is successfully created, the response will include the product`id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Create Cluster Product":{"value":{"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1}},"Create Option Product":{"value":{"costPrice":19.05,"descriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"language":"NL","manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"notes":[{"language":"NL","value":"option product"}],"oemCode":"K72334","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":22.3,"shortDescriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"shortName":"Dell draadloze lasermuis via nano USB ontvanger","sku":"K72334","source":"REST-API","sourceId":"K72334","status":"A","suggestedPrice":22.3,"supplier":"REST-API","supplierCode":"K72334","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Option Product - 201 / Create Cluster Product - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"973"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:22:32 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a7b7f777-e7ad-4932-9a3b-d48a76cdd07b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":19.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707972},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"DELL"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"option product"}}},"example":[{"language":"NL","value":"option product"}]},"oemCode":{"type":"string","example":"K72334"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":22.3},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"}}},"example":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}]},"shortName":{"type":"string","example":"Dell draadloze lasermuis via nano USB ontvanger"},"sku":{"type":"string","example":"K72334"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":22.3},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"K72334"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product created"},"example":["Cluster Product created"]},"total":{"type":"number","example":1}}},"examples":{"Create Cluster Product - 201":{"value":{"data":{"costPrice":1.05,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","id":707966,"language":"NL","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1},"messages":["Cluster Product created"],"total":1}},"Create Option Product - 201":{"value":{"data":{"costPrice":19.05,"descriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"id":707972,"language":"NL","manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"notes":[{"language":"NL","value":"option product"}],"oemCode":"K72334","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":22.3,"shortDescriptions":[{"language":"NL","value":"Dell draadloze lasermuis via nano USB ontvanger"}],"shortName":"Dell draadloze lasermuis via nano USB ontvanger","sku":"K72334","source":"REST-API","sourceId":"K72334","status":"A","suggestedPrice":22.3,"supplier":"REST-API","supplierCode":"K72334","taxCode":"H","unit":1},"messages":["Cluster Product created"],"total":1}}}}}},"404":{"description":"Create Cluster Product - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:22:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"6d9bf531-516c-4bec-9305-e49b5ab1b9d4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [213] not found"},"example":["Parent Cluster with id [213] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Create Cluster Product - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [213] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Order

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-order.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Order"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an order.

## Order identification

Orders imported via the REST api need to specify an `order`identifier. This identifier is used by Propeller to determine if an order has already been imported before into Propellor or not.

```json
{
    "source" : "MsBusinessCentral",
    "sourceId :  "order-1234"
}
```

## Create an order using an existing user resource

Orders can be created referencing an existing `user` / `contact` or `customer` resource. A user resource can be referenced using a [lookupKey](/reference/legacy/rest-v1/orders#order-lookup-keys) in the `clientData` element.

```json
{
    "clientData": {
        "user": {
            "source" : "MsBusinessCentral",
            "sourceId :  "user-1234"
        }
    }
}
```

## Create an order using the anonymous user

Creating an order can be done without referencing an existing `user`,`contact` or `customer` object. When no `clientData`element is present in the payload a `firstName`, `middleName`, `lastName` and `email` needs to be present in the root or the `order` payload.

```json
{
    "firstName" : "Miles",
    "middleName" : "",
    "lastName" : "McCoy",
    "email" : "miles@propel.us"
}
```

Anonymous orders are not linked to any existing `user` / `contact` or `customer` resource in Propeller. Anonymous orders are e.g. usefull when Propeller acts as a "in between" a marketplace (e.g. Amazon) and an ERP system. Marketplace orders are imported into Propeller and from Propeller exported to the ERP system. There is no added value of creating separate users for each Marketplace order in Propeller.

## Referencing products as order items

an `orderItem` always contains a reference to an existing `product` using a [lookupKey](/reference/legacy/rest-v1/orders#order-lookup-keys)

```json
{
   "type": "product",
   "source" : "MsBusinessCentral",
   "sourceId :  "product-1234"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"accountingId":{"type":"string","example":""},"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"contact":{"type":"object","properties":{"source":{"type":"string","example":"MsBusinessCentral"},"sourceId":{"type":"string","example":"contact-1234"}}}}},"date":{"type":"string","example":"2023-03-03T13:10:45"},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"url":{"type":"string","example":"www.propel.us"}}}}},"items":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number","example":2},"sku":{"type":"string","example":"411544"},"type":{"type":"string","example":"product"}}},"example":[{"quantity":2,"sku":"411544","type":"product"}]},"language":{"type":"string","example":"EN"},"merchantCost":{"type":"number","example":4.9},"reference":{"type":"string","example":"reference text"},"remarks":{"type":"string","example":"remarks text"},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"url":{"type":"string","example":"www.propel.us"}}}}},"source":{"type":"string","example":"MsBusinessCentral"},"sourceId":{"type":"string","example":"order-123478"},"status":{"type":"string","example":"NEW"},"total":{"type":"object","properties":{"discountAmount":{"type":"number","example":5}}},"trackTraceCode":{"type":"string","example":""}}},"examples":{"Create Order":{"value":{"accountingId":"","channelId":1,"clientData":{"contact":{"source":"MsBusinessCentral","sourceId":"contact-1234"}},"date":"2023-03-03T13:10:45","invoiceData":{"address":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","gender":"U","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","url":"www.propel.us"}},"items":[{"quantity":2,"sku":"411544","type":"product"}],"language":"EN","merchantCost":4.9,"reference":"reference text","remarks":"remarks text","shippingData":{"address":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","gender":"U","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","url":"www.propel.us"}},"source":"MsBusinessCentral","sourceId":"order-123478","status":"NEW","total":{"discountAmount":5},"trackTraceCode":""}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Order - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2431"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 10:53:12 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"5a7bf152-60fd-4b7d-b022-6a438ff8a4a5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"accountingId":{"type":"string","example":""},"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"AU"},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":"ANONYMOUS"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Anonymous"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14644},"lastName":{"type":"string","example":"User"},"login":{"type":"string","example":""},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":"Anonymous User"},"phone":{"type":"string","example":""},"pricelistAmount":{"type":"string","example":"JONSPR"},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":""},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""}}},"date":{"type":"string","example":"2023-03-03T13:10:45"},"debtorId":{"type":"string","example":"ANONYMOUS"},"email":{"type":"string","example":"miles@propel.us"},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":"extrainfo text"},"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":557},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":105950},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"items":{"type":"array","items":{"type":"object","properties":{"childItems":{"type":"array","items":{},"example":[]},"discountAmount":{"type":"number","example":0},"discountAmountNet":{"type":"number","example":0},"discountAmountTotal":{"type":"number","example":0},"discountAmountTotalNet":{"type":"number","example":0},"discountPercentage":{"type":"number","example":0},"name":{"type":"string","example":"Drum Oki 44318508 zwart"},"notes":{"type":"string","example":""},"price":{"type":"number","example":71.74},"quantity":{"type":"number","example":2},"sku":{"type":"string","example":"411544"},"supplier":{"type":"string","example":""},"supplierCode":{"type":"string","example":""},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"type":{"type":"string","example":"product"},"unit":{"type":"number","example":1}}},"example":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Drum Oki 44318508 zwart","notes":"","price":71.74,"quantity":2,"sku":"411544","supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"type":"product","unit":1}]},"language":{"type":"string","example":""},"lastName":{"type":"string","example":"McCoy"},"merchantCost":{"type":"number","example":4.9},"middleName":{"type":"string","example":""},"orderSource":{"type":"string","example":"API"},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"string","example":""},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"pickUpLocationId":{"type":"number","example":0},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":"reference text"},"remarks":{"type":"string","example":"remarks text"},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":105951},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shop":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Propellor Sonar"}}},"shopId":{"type":"number","example":1},"status":{"type":"string","example":"NEW"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":3.48481},"discountValue":{"type":"number","example":5},"tax":{"type":"object","properties":{"0":{"type":"number","example":0},"21":{"type":"number","example":29.6058}}},"totalGross":{"type":"number","example":138.48},"totalNet":{"type":"number","example":167.5608}}},"trackTraceCode":{"type":"string","example":""},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14644}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Create Order - 200":{"value":{"data":{"accountingId":"","channelId":1,"clientData":{"abbreviation":"AU","dateOfBirth":"","debtorId":"ANONYMOUS","email":"","fax":"","firstName":"Anonymous","gender":"U","id":14644,"lastName":"User","login":"","middleName":"","mobile":"","name":"Anonymous User","phone":"","pricelistAmount":"JONSPR","pricelistPercentage":"","primaryLanguage":"","ssn":"","title":""},"date":"2023-03-03T13:10:45","debtorId":"ANONYMOUS","email":"miles@propel.us","externalId":"","extraInfo":"extrainfo text","firstName":"Miles","id":557,"invoiceData":{"address":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":105950,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"","name":"","notes":"","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"invoice","url":""}},"itemCount":1,"items":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Drum Oki 44318508 zwart","notes":"","price":71.74,"quantity":2,"sku":"411544","supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"type":"product","unit":1}],"language":"","lastName":"McCoy","merchantCost":4.9,"middleName":"","orderSource":"API","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":"","transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","pickUpLocationId":0,"postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"reference text","remarks":"remarks text","shippingData":{"address":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":105951,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"","name":"","notes":"","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":""}},"shop":{"id":1,"name":"Propellor Sonar"},"shopId":1,"status":"NEW","total":{"discountPercentage":3.48481,"discountValue":5,"tax":{"0":0,"21":29.6058},"totalGross":138.48,"totalNet":167.5608},"trackTraceCode":"","type":"dropshipment","userId":14644},"messages":[],"total":1}}}}}},"400":{"description":"Create Order - 400 (order already exists)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 10:54:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"29e614eb-af2f-416e-8d36-0992efded582"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15004},"messages":{"type":"array","items":{"type":"string","example":"Order with sourceId [order-1234] already exists"},"example":["Order with sourceId [order-1234] already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"OrderExists"}}}}},"examples":{"Create Order - 400 (order already exists)":{"value":{"error":{"code":15004,"messages":["Order with sourceId [order-1234] already exists"],"moreInfo":"https://www.propel.us/docs/errors/15004","status":400,"type":"OrderExists"}}}}}}},"404":{"description":"Create Order - 404 (product not found) / Create Order - 404 (contact not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"179"}},"date":{"schema":{"type":"string","example":"Fri, 03 Feb 2023 11:00:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"da7a3f29-97e5-4fb1-a45d-a361139d742a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"product with sku [411544167] not found"},"example":["product with sku [411544167] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Order - 404 (contact not found)":{"value":{"error":{"code":50006,"messages":["contact with sourceId [contact-1234] not found"],"moreInfo":"https://www.propel.us/docs/errors/50006","status":404,"type":"contactNotFound"}}},"Create Order - 404 (product not found)":{"value":{"error":{"code":80006,"messages":["product with sku [411544167] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Pricesheet Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-pricesheet-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Pricesheet Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/pricesheets/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing price sheet. The price sheet can be identified by it's lookup key. It is required to provide either `categories` or `products` or both.

## Use cases

A common use case for this endpoint is when you want to give discounts on all products in a certain category or set a specific price from your ERP system for a product. You can decide to assign a price sheet to only one or multiple users. You can also create a price sheet in advance, create the pricing and have it be ready to assign to a user or usergroup at any given moment i.e. when a sales team decides to.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The discount will apply on all products that belong in that category.

Another common use case is to set a specific price for a product. This is usually used when your ERP system is responsible for the complex price calculations or simply your sales team agreed on a specific price for a product.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-v1/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":17795},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"CP"},"validFrom":{"type":"string","example":"2022-05-01"},"validTo":{"type":"string","example":"2022-12-31"}}}}},"example":[{"id":17795,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"2022-05-01","validTo":"2022-12-31"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":40364},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"SP"},"validFrom":{"type":"string","example":"2022-05-01"},"validTo":{"type":"string","example":"2022-12-31"}}}}},"example":[{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"2022-05-01","validTo":"2022-12-31"}},{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"2022-05-01","validTo":"2022-12-31"}}]}}},"examples":{"Create Pricesheet Pricing":{"value":{"categories":[{"id":17795,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"2022-05-01","validTo":"2022-12-31"}}],"products":[{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"2022-05-01","validTo":"2022-12-31"}},{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"2022-05-01","validTo":"2022-12-31"}}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Pricesheet Pricing / Create Pricesheet Pricing - 200 (invalid category)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"285"}},"date":{"schema":{"type":"string","example":"Fri, 01 Apr 2022 07:52:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fe6530f0-afa0-4a82-bcd4-7d797245d595"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"key":{"type":"number","example":1779},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1779,"lookupKey":"id","success":true},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Pricesheet Pricing":{"value":{"data":[{"action":"create","key":1779,"lookupKey":"id","success":true},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}],"messages":["completed"],"total":3}},"Create Pricesheet Pricing - 200 (invalid category)":{"value":{"data":[{"action":"create","error":"category with id [17795] not found","key":17795,"lookupKey":"id","success":false},{"action":"create","key":40364,"lookupKey":"id","success":true},{"action":"create","key":40362,"lookupKey":"id","success":true}],"messages":["completed"],"total":3}}}}}},"400":{"description":"Create Pricesheet Pricing - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:19:46 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e580c6c8-feda-473b-9efd-d40d1454c708"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [product] is not permitted"},"example":["#: extraneous key [product] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Pricesheet Pricing - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [product] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Pricesheet Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"200"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:33:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"00967621-4860-45b6-8e44-1eb6d4fffc09"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12005},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Pricesheets] with code [3A212] not found"},"example":["Parent resource [Pricesheets] with code [3A212] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentPricesheetsNotFound"}}}}},"examples":{"Create Pricesheet Pricing - 404":{"value":{"error":{"code":12005,"messages":["Parent resource [Pricesheets] with code [3A212] not found"],"moreInfo":"https://www.propel.us/docs/errors/12005","status":404,"type":"ParentPricesheetsNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Pricesheet

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-pricesheet.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Pricesheet"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/pricesheets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a price sheet. If a price sheet is successfully created, the response will include the price sheet `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `code` | yes |
| `shopId` | no  <br />Defaults to first shop found |
| `name` | no |
| `description` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"number","example":21}}},"examples":{"Create Pricesheet":{"value":{"code":"3A21","description":"","name":21}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Pricesheet - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"120"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:15:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"91f4a72b-2056-40ad-a8ba-0527a80d7abc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"id":{"type":"number","example":11},"name":{"type":"string","example":"Pricesheet 3A21"}}},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet created"},"example":["Pricesheet created"]},"total":{"type":"number","example":1}}},"examples":{"Create Pricesheet - 200":{"value":{"data":{"code":"3A21","description":"","id":11,"name":"Pricesheet 3A21"},"messages":["Pricesheet created"],"total":1}}}}}},"400":{"description":"Create Pricesheet - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"188"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:16:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"983ca163-ac57-472e-b246-e57674fbd5a0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/name: expected type: String, found: Integer"},"example":["#/name: expected type: String, found: Integer"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Pricesheet - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/name: expected type: String, found: Integer"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product Local Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-product-local-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product Local Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/{lookupkey}/{key}/inventory/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows creating local inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

On creating a record, inventory type **local** is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: **sku**, **warehouseId** and **location,** error is thrown that duplicate record can't be created.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":16},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Create Product Local Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":16,"usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product Local Inventory - 201 / Create Product Local Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"330"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 15:08:39 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T11:04:29"},"id":{"type":"number","example":16194},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":16},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory created"},"example":["Inventory created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product Local Inventory - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T11:04:29","id":16194,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory created"],"total":1}},"Create Product Local Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T15:08:39","id":16148,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227235,"quantity":16,"sku":"9789006953374","supplier":"INTERN","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory created"],"total":1}}}}}},"400":{"description":"Create Product Local Inventory - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"157"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:04:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6fa715b9-3713-4c89-bdf1-069517106c53"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13004},"messages":{"type":"array","items":{"type":"string","example":"Inventory already exists"},"example":["Inventory already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InventoryExists"}}}}},"examples":{"Create Product Local Inventory - 400":{"value":{"error":{"code":13004,"messages":["Inventory already exists"],"moreInfo":"https://www.propel.us/docs/errors/13004","status":400,"type":"InventoryExists"}}}}}}},"404":{"description":"Create Product Local Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:05:01 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"298fde61-a7bd-4f67-a059-fae3ea541591"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Product Local Inventory - 404":{"value":{"error":{"code":80006,"messages":["Product with id [98952] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product Supplier Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-product-supplier-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product Supplier Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/{lookupkey}/{key}/inventory/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows creating supplier inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | yes |
| `supplier` (string) | no  <br />Default value is product supplier |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup`  <br />([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

On creating a record, inventory type **supplier** is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: **supplier**, **supplierCode**, **warehouseId** and **location,** error is thrown that duplicate record can't be created.

## InventoryCompanyUsergroup Resource

A `InventoryCompanyUsergroup` resource is a JSON object used for identifying a company or usergroup when creating company/ usergroup specific stock record. It can be identified by either an id or source/ sourceId.

```json
{
    "id": 56987
}
```
```json
   "sourceId": "1",
   "source": "TECHDATA",
   "language": "NL"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":16},"supplier":{"type":"string","example":"KERRIDGE"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Create Product Supplier Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":16,"supplier":"KERRIDGE","usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product Supplier Inventory - 201 / Create Product Supplier Inventory for a usergroup - 201","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"332"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 15:03:49 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T11:06:39"},"id":{"type":"number","example":16195},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":16},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"KERRIDGE"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory created"},"example":["Inventory created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product Supplier Inventory - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T11:06:39","id":16195,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory created"],"total":1}},"Create Product Supplier Inventory for a usergroup - 201":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T15:03:49","id":16146,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227235,"quantity":16,"sku":"9789006953374","supplier":"KERRIDGE","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory created"],"total":1}}}}}},"400":{"description":"Create Product Supplier Inventory - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"157"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:06:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"727ad1af-8637-4512-8e7d-1be97c91017f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13004},"messages":{"type":"array","items":{"type":"string","example":"Inventory already exists"},"example":["Inventory already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InventoryExists"}}}}},"examples":{"Create Product Supplier Inventory - 400":{"value":{"error":{"code":13004,"messages":["Inventory already exists"],"moreInfo":"https://www.propel.us/docs/errors/13004","status":400,"type":"InventoryExists"}}}}}}},"404":{"description":"Create Product Supplier Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 11:07:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b22dee12-41cb-411e-813b-56370e516d45"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Create Product Supplier Inventory - 404":{"value":{"error":{"code":80006,"messages":["Product with id [98952] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Product

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-product.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Product"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/products/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single product. If a product is successfully created, the response will include the product`id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `language` | yes |
| `parent` | no |
| `sku` | no (recommended) |
| `unit` | no  <br />Default is `1` |
| `status` | no  <br />Default is `A` |
| `price` | no  <br />Default is `0.00` |
| `costPrice` | no  <br />Default is `0.00` |
| `suggestedPrice` | no  <br />Default is `0.00` |
| `priceDisplay` | no  <br />Default is `default` |
| `descriptions` | no |
| `shortName` | no |
| `shortDescriptions` | no |
| `taxCode` | no  <br />Default is `H` |
| `supplier` | no (recommended) |
| `supplierCode` | no (recommended) |
| `manufacturer` | no |
| `oemCode` | no |
| `eanCode` | no |
| `minimumQuantity` | no  <br />Default is `1` |
| `package` | no |
| `packageDescriptions` | no |
| `notes` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `keywords` | no |
| `customKeywords` | no |
| `statusExtra` | no |
| `orderable` | no |
| `orderableFrom` | no |
| `orderableTo` | no |
| `releaseDate` | no |
| `returnable` | no |
| `physical` | no |
| `barCode` | no |
| `width` | no |
| `height` | no |
| `depth` | no |
| `weight` | no |
| `packageUnit` | no |
| `packageUnitQuantity` | no |
| `purchaseMinimumQuantity` | no |
| `purchaseUnit` | no |
| `economicOrderQuantity` | no |        
| `metadataTitles` | no |
| `metadataDescriptions` | no |
| `metadataKeywords` | no |
| `metadataCanonicalUrls` | no |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Create Product":{"value":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","language":"NL","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Product - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2854"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d6169a2d-ed01-4abd-b306-4da9e44d56bb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"language":{"type":"string","example":"NL"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1771}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Product created"},"example":["Product created"]},"total":{"type":"number","example":1}}},"examples":{"Create Product - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"language":"NL","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1771},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},"messages":["Product created"],"total":1}}}}}},"400":{"description":"Create Product - 400 (existing sourceId)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"180"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:15:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e7ee4951-7e62-4923-bc92-04030f60ec74"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80004},"messages":{"type":"array","items":{"type":"string","example":"Product with sourceId [NCABD70004] already exists"},"example":["Product with sourceId [NCABD70004] already exists"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80004"},"status":{"type":"number","example":400},"type":{"type":"string","example":"ProductExists"}}}}},"examples":{"Create Product - 400 (existing sourceId)":{"value":{"error":{"code":80004,"messages":["Product with sourceId [NCABD70004] already exists"],"moreInfo":"https://www.propel.us/docs/errors/80004","status":400,"type":"ProductExists"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Shipment

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-shipment.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Shipment"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/{lookupKey}/{lookupValue}/shipments"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a `shipment` which marks `orderItems` as delivered and adds track and trace information to the `order`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `deliveryId` | yes |
| `deliveryDate` | no |
| `supplier` | yes |
| `colli` | no |
| `notes` | no |
| `shipDate` | no |
| `items` | yes |
| `items`.sku | yes |
| `items`.name | yes |
| `items`.supplierCode | no |
| `items`.quantity | yes |
| `items`.cancelled | no  <br />  <br />Default is `0` |
| `items`.notes | no |
| `items`.externalLineId | no |
| `tracktrace` | no |
| `tracktrace`.carrierName | yes |
| `carrierName`.code | yes |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"colli":{"type":"number","example":1},"deliveryDate":{"type":"string","example":"2022-05-21T00:00:00"},"deliveryId":{"type":"string","example":"D185FA63-38F0-4612-B4413FA5B71E3CE6"},"items":{"type":"array","items":{"type":"object","properties":{"externalLineId":{"type":"string","example":""},"name":{"type":"string","example":"Gallagher MBS400 fence energiser (230V/12V/Solar)"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":1},"sku":{"type":"string","example":"390307"},"supplierCode":{"type":"string","example":"390307"}}},"example":[{"externalLineId":"","name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","quantity":1,"sku":"390307","supplierCode":"390307"}]},"notes":{"type":"string","example":""},"supplier":{"type":"string","example":"INTERN"},"tracktrace":{"type":"array","items":{"type":"object","properties":{"carrierName":{"type":"string","example":"DHL"},"code":{"type":"string","example":"12345"}}},"example":[{"carrierName":"DHL","code":"12345"}]}}},"examples":{"Create Shipment":{"value":{"colli":1,"deliveryDate":"2022-05-21T00:00:00","deliveryId":"D185FA63-38F0-4612-B4413FA5B71E3CE6","items":[{"externalLineId":"","name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","quantity":1,"sku":"390307","supplierCode":"390307"}],"notes":"","supplier":"INTERN","tracktrace":[{"carrierName":"DHL","code":"12345"}]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Shipment - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"55"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 18:04:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"69b34018-6b10-4362-bdde-21a2125b7925"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Shipment created"},"example":["Shipment created"]},"total":{"type":"number","example":1}}},"examples":{"Create Shipment - 200":{"value":{"data":{},"messages":["Shipment created"],"total":1}}}}}},"400":{"description":"Create Shipment - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"234"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 17:46:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b11b44a6-a84b-4868-b66a-668d718e2dac"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/items/0: required key [sku] not found"},"example":["#/items/0: required key [sku] not found","#/items/0: extraneous key [code] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Shipment - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/items/0: required key [sku] not found","#/items/0: extraneous key [code] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Shipment - 404 (order not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Mon, 25 Apr 2022 18:10:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c0e35a45-6752-466c-bab2-f7034f9d516f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [300] not found"},"example":["Order with id [300] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Create Shipment - 404 (order not found)":{"value":{"error":{"code":15001,"messages":["Order with id [300] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a user. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create User Address":{"value":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create User Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create User Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81908,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create User Address - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create User Address - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create User Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Create User Address - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-user-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing user. The user can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific user.

If you want to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The user will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for a single user.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14718"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":50887},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":50887,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1036521},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":1036521,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create User Pricing":{"value":{"categories":[{"id":50887,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":1036521,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create User Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:18:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7f30de39-8de3-4357-9069-82d776161996"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"error":{"type":"string","example":"product with id [1036522] not found"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create User Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}],"messages":["completed"],"total":3}}}}}},"404":{"description":"Create User Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"186"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 13:53:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"71944e53-63f3-4944-83cd-e2852346da21"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [14699] not found"},"example":["Parent resource [User] with id [14699] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Create User Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [14699] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create User

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-user.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create User"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single user. If a user is successfully created, the response will include the user `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `debtorId` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `fullName` | no |
| `title` | no |
| `dateOfBirth` | no |
| `gender` | no |
| `login` | no |
| `phone` | no |
| `email` | no |
| `company` | no |
| `parent` | no |
| `pricelistAmount` | no |
| `pricelistPercentage` | no |
| `taxNumber` | no |
| `cocNumber` | no |
| `primaryLanguage` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Create User":{"value":"{\r\n    \"language\": \"NL\",\r\n    \"parent\": {\r\n        \"id\": 119\r\n    },\r\n    \"firstName\": Miles,\r\n    \"middleName\": \"\",\r\n    \"lastName\": \"McCoy\",\r\n    \"abbreviation\": \"MM\",\r\n    \"debtorId\": 12345,\r\n    \"email\": \"miles@propel.us\",\r\n    \"mobile\": \"0038975648\",\r\n    \"phone\": \"0032445888\",\r\n    \"dateOfBirth\": \"28/08/1993\",\r\n    \"title\": \"Mr.\",\r\n    \"gender\": \"M\",\r\n    \"login\": \"miles@propel.us\",\r\n    \"source\": \"REST-API\",\r\n    \"sourceId\": 3002196\r\n}"}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create User - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"352"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:41:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0e0d6f5b-db70-49df-89b0-ae2c724556dc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14759},"language":{"type":"string","example":"NL"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"User created"},"example":["User created"]},"total":{"type":"number","example":1}}},"examples":{"Create User - 201":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":14759,"language":"NL","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["User created"],"total":1}}}}}},"400":{"description":"Create User - 400 (invalid payload)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:44:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d91d8445-2728-4a75-91b0-1b52c6066a9b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10005},"messages":{"type":"array","items":{"type":"string","example":"Invalid JSON Payload"},"example":["Invalid JSON Payload"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidJSONPayload"}}}}},"examples":{"Create User - 400 (invalid payload)":{"value":{"error":{"code":10005,"messages":["Invalid JSON Payload"],"moreInfo":"https://www.propel.us/docs/errors/10005","status":400,"type":"InvalidJSONPayload"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-usergroup-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup Address"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create an address for a usergroup. If the address is successfully created, the response will include the address `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `type` | yes |
| `code` | no |
| `firstName` | no |
| `middleName` | no |
| `lastName` | no |
| `gender` | no  <br />Default is `U` |
| `street` | yes |
| `number` | no |
| `numberExtension` | no |
| `postalCode` | no |
| `city` | yes |
| `country` | yes |
| `region` | no |
| `icp` | no  <br />  <br />Default is `N` |
| `phone` | no |
| `mobile` | no |
| `email` | no |
| `company` | no |
| `url` | no |
| `isDefault` | no  <br />  <br />Default is `N` |
| `notes` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"examples":{"Create Usergroup Address":{"value":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Usergroup Address - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"418"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d9386a-4819-45c5-850d-1128b3787284"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{"type":"string","example":"Address created"},"example":["Address created"]},"total":{"type":"number","example":1}}},"examples":{"Create Usergroup Address - 201":{"value":{"data":{"city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","firstName":"Miles","icp":"N","id":81918,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":["Address created"],"total":1}}}}}},"400":{"description":"Create Usergroup Address - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:12:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c832f1f5-fc43-42b1-9e4d-985d39ab1437"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Create Usergroup Address - 400":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Create Usergroup Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Thu, 17 Mar 2022 01:14:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"18818ab4-2d7c-4f8a-a8c1-b1ae1d1ea913"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Create Usergroup Address - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-usergroup-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup Pricing"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to define [pricing](/reference/legacy/rest-v1/pricesheets) for an existing usergroup. The usergroup can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.

## Use cases

A common use case for this endpoint is when you want to give discounts only for a specific usergroup and all users in that usergroup. If a user in that usergroup already has pricing defined, the price set on the parent usergroup will be ignored.

If you want for ex. to give a discount of 20% of sales price on all products in a given category you can use the `SP` type pricing for a category. The usergroup will have discounted prices on all products that belong in that category.

Another common use case is to set a specific price for a product only for users in a given usergroup.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":1797},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"type":{"type":"string","example":"CP"}}}}},"example":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}]},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":77138},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"type":{"type":"string","example":"SP"}}}}},"example":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}]},"shopId":{"type":"number","example":1}}},"examples":{"Create Usergroup Pricing":{"value":{"categories":[{"id":1797,"pricing":{"amount":10,"type":"CP"}}],"products":[{"id":77138,"pricing":{"amount":20,"type":"SP"}},{"id":1036522,"pricing":{"price":4}}],"shopId":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Create Usergroup Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"287"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:40:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"463a1983-f185-4027-9906-e95c8884711e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"create"},"error":{"type":"string","example":"product with id [1036522] not found"},"key":{"type":"number","example":1797},"lookupKey":{"type":"string","example":"id"},"success":{"type":"boolean","example":true}}},"example":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}]},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]},"total":{"type":"number","example":3}}},"examples":{"Create Usergroup Pricing - 200":{"value":{"data":[{"action":"create","key":1797,"lookupKey":"id","success":true},{"action":"create","key":77138,"lookupKey":"id","success":true},{"action":"create","error":"product with id [1036522] not found","key":1036522,"lookupKey":"id","success":false}],"messages":["completed"],"total":3}}}}}},"404":{"description":"Create Usergroup Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"197"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:31:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a009a732-a593-4242-aed6-0ad86535ca35"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [122589] not found"},"example":["Parent resource [Usergroup] with id [122589] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Create Usergroup Pricing - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [122589] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Create Usergroup

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/create-usergroup.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create Usergroup"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to create a single usergroup. If a usergroup is successfully created, the response will include the usergroup `id`.

## Fields

| **Name** | **Required** |
| --- | --- |
| `name` | no |
| `language` | no |
| `parent` | no |
| `company` | no |
| `department` | no |
| `office` | no |
| `notes` | no |
| `inheritProductList` | no  <br />  <br />Default is `Y` |
| `inheritOrderList` | no  <br />  <br />Default is `Y` |
| `budget` | no  <br />  <br />Default is `N` |
| `budgetInherit` | no  <br />  <br />Default is `Y` |
| `orderListAllowAll` | no  <br />  <br />Default is `U` |
| `sourceId` | no |
| `source` | only when sourceId is provided |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"examples":{"Create Usergroup":{"value":"{\r\n    \"language\": \"NL\",\r\n    \"parent\": {\r\n        \"id\": 119\r\n    },\r\n    \"name\": Netherlands,\r\n    \"company\": \"\",\r\n    \"department\": \"\",\r\n    \"office\": \"\",\r\n    \"notes\": \"Usergroup created from API\",\r\n    \"inheritProductList\": \"Y\",\r\n    \"inheritOrderList\": \"N\",\r\n    \"budget\": \"N\",\r\n    \"budgetInherit\": \"N\"\r\n}"}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Create Usergroup - 201","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"278"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:14:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"05af9b7b-c9d1-408d-bd8e-be10812818a7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"language":{"type":"string","example":"NL"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup created"},"example":["Usergroup created"]},"total":{"type":"number","example":1}}},"examples":{"Create Usergroup - 201":{"value":{"data":{"budget":"N","budgetInherit":"N","company":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","language":"NL","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}},"messages":["Usergroup created"],"total":1}}}}}},"400":{"description":"Create Usergroup - 400 (invalid payload)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:44:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d91d8445-2728-4a75-91b0-1b52c6066a9b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10005},"messages":{"type":"array","items":{"type":"string","example":"Invalid JSON Payload"},"example":["Invalid JSON Payload"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidJSONPayload"}}}}},"examples":{"Create Usergroup - 400 (invalid payload)":{"value":{"error":{"code":10005,"messages":["Invalid JSON Payload"],"moreInfo":"https://www.propel.us/docs/errors/10005","status":400,"type":"InvalidJSONPayload"}}}}}}}}}
>
  
</StatusCodes>

---

## Customers

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/customers.tag

<LegacyBanner />



Customers represent data about a specific customer. Carts, orders, attributes, addresses are associated with customers.

In a B2C environment a customer is the actual user ordering products.

> The customer API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API 
  

## Customer Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `customer` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `debtorId` | A unique id representing this customer. A debtorId can be automatically generated by Propellor | integer  <br />string  <br /> |
| `firstName` | Customer first name | string |
| `middleName` | Customer middle name | string |
| `lastName` | Customer last name | string |
| `abbreviation` | Customer abbreviation | string |
| `title` | Customer title | string |
| `dateOfBirth` | Customer date of birth | date |
| `gender` | Customer gender | enum  <br />  <br />**m**\=Male  <br />**f**\=Female  <br />**u**\=Undefined |
| `login` | Login name used to login to the webshop | string |
| `phone` | Customer phone number | string |
| `email` | A valid email address | string |
| `ssn` | Customer ssn | integer |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with source |
| `pricelistAmount` | A `pricesheet` code in case of special pricing agreements | string |
| `pricelistPercentage` | A `pricesheet` code in case of special pricing agreements | string |
| `primaryLanguage` | Customer primary language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Customer Errors

This section describes error codes specific for the `Customer` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `60004` | CustomerExists | 400 | Customer already exists | Customer with such lookup key already exists |
| `60005` | CustomerMultipleFound | 400 | Multuple customers found. Please provide additional filters | Multiple customers with such lookup key exist |
| `60006` | CustomerNotFound | 404 | Customer does not exist | Customer with such lookup key not found |
| `60007` | ParentCustomerNotFound | 404 | Parent customer does not exist | Parent customer with such lookup key not found. This error is typical when working with customer sub-resources (e.g. attributes, addresses) |
| `60008` | CustomerNotAllowed | 405 | Customer is not allowed | Usually when customer is in Recycle Bin and can't be used |
| `90006` | AddressNotFound | 404 | Address does not exist | Customer address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Delete attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to delete an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.  
  
When an attribute is deleted all the values set on resources (products, users, etc.) will be deleted as well.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete attribute by Id - 200 / Delete attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:53:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"940ff23c-8c5d-4d9a-b533-408e456a960f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Attribute deleted"},"example":["Attribute deleted"]}}},"examples":{"Delete attribute by Id - 200":{"value":{"data":{},"messages":["Attribute deleted"]}},"Delete attribute by name and class - 200":{"value":{"data":{},"messages":["Attribute deleted"]}}}}}},"404":{"description":"Delete attribute by Id - 404 / Delete attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"202"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:53:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"da6ad28e-989d-4ac2-a52c-a499b9944219"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [85] not found."},"example":["Attribute with id [85] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Delete attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [85] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Delete attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [COLOR] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"45"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:50:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"17694f03-bade-42cd-b6eb-6d3a8a26e059"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Category deleted"},"example":["Category deleted"]}}},"examples":{"Delete Category by Id - 200":{"value":{"data":{},"messages":["Category deleted"]}}}}}},"404":{"description":"Delete Category by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:51:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ba822dc2-7469-4fe8-947c-df32cc262366"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [2947] not found"},"example":["Category with sourceId [2947] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Delete Category by Id - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [2947] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Category translation by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-category-translation-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Category translation by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/categories/{lookupKey}/{lookupValue}/translation/{translationLanguage}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete category translation by lookup key and the language for which the translation needs to be deleted. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1773"},"description":"The value of the key (id or sourceId)"},{"name":"translationLanguage","in":"path","required":true,"schema":{"type":"string","example":"FR"},"description":"The language to delete. Cannot be the default language of the category"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Category translation by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"48"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:26:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"339c22fa-5963-4449-ba88-b36251b74bd7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Translation deleted"},"example":["Translation deleted"]}}},"examples":{"Delete Category translation by Id - 200":{"value":{"data":{},"messages":["Translation deleted"]}}}}}},"404":{"description":"Delete Category translation by Id - 404 (Category not found) / Delete Category translation by Id - 404 (Translation not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:27:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0b6c651a-8a34-4e95-894e-b9acf9da929c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with id [2947] not found"},"example":["Category with id [2947] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Delete Category translation by Id - 404 (Category not found)":{"value":{"error":{"code":30006,"messages":["Category with id [2947] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}},"Delete Category translation by Id - 404 (Translation not found)":{"value":{"error":{"code":10018,"messages":["[FR] translation for category with id [1773] not found"],"moreInfo":"https://www.propel.us/docs/errors/10018","status":404,"type":"TranslationNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete cluster by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Cluster by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:43:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"716bdaeb-9ef7-402d-9fb3-ef76ee5fe20b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster deleted"},"example":["Cluster deleted"]}}},"examples":{"Delete Cluster by lookup key - 200":{"value":{"data":{},"messages":["Cluster deleted"]}}}}}},"404":{"description":"Delete Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"164"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:43:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"421ba89a-a9cf-4449-92e1-34ba209a81c3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [213] not found"},"example":["Cluster with id [213] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Delete Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [213] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Company Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-company-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Company Address"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a company address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106078"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Company Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:16:38 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a1ca47ef-14b0-40da-ab4a-19a58eb17024"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Address deleted"},"example":["Address deleted"]}}},"examples":{"Delete Company Address - 200":{"value":{"data":{},"messages":["Address deleted"]}}}}}},"404":{"description":"Delete Company Address - 404 (company) / Delete Company Address - 404 (address)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:17:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"33e4d2a9-6688-457c-a5d2-605e3f3f5076"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Delete Company Address - 404 (address)":{"value":{"error":{"code":90006,"messages":["Address with id [106077] not found for [Companies] with id [9482]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Delete Company Address - 404 (company)":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Company by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-company-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Company by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/companies/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a company by a specific lookupKey / lookupId combination. A deleted company will be moved to the Propeller Recycle bin. This means the deleted company can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"646"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Company by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:26:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c038ed9b-1b4f-41ce-bcca-c855c241694b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Company deleted"},"example":["Company deleted"]}}},"examples":{"Delete Company by lookup key - 200":{"value":{"data":{},"messages":["Company deleted"]}}}}}},"400":{"description":"Delete Company by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:27:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"ebe85a54-4572-4e28-9d69-9ccb8060d13c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete Company by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete Company by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"171"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:28:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f71ae4cc-5c86-42e1-9d1c-1da8171e1a26"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40006},"messages":{"type":"array","items":{"type":"string","example":"Company with sourceId [9483] not found"},"example":["Company with sourceId [9483] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CompanyNotFound"}}}}},"examples":{"Delete Company by lookup key - 404":{"value":{"error":{"code":40006,"messages":["Company with sourceId [9483] not found"],"moreInfo":"https://www.propel.us/docs/errors/40006","status":404,"type":"CompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Company Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-company-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Company Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/companies/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing company. The company can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Company Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:26:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"121cfbf7-1b14-4b39-9c64-77b287c03cce"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Company Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Company Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"197"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:41:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2fb9ab1b-d503-41ee-8aeb-4a00acd52df8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [122589] not found"},"example":["Parent resource [Company] with id [122589] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Delete Company Pricing - 404":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [122589] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Contact by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-contact-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Contact by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/contacts/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a `contact` by a specific lookupKey / lookupId combination. A deleted `contact` will be moved to the Propeller Recycle bin. This means the deleted contact can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25493"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Contact by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:45:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"15e7d72b-dfa1-4ae4-ba98-2018e9c41bac"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Contact deleted"},"example":["Contact deleted"]}}},"examples":{"Delete Contact by lookup key - 200":{"value":{"data":{},"messages":["Contact deleted"]}}}}}},"400":{"description":"Delete Contact by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:45:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"284f7a22-14ec-4118-b4ac-5d112afee0fb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete Contact by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete Contact by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"172"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:45:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"10475e20-5e05-4712-8c31-90cdc149d7b2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":50006},"messages":{"type":"array","items":{"type":"string","example":"Contact with sourceId [25494] not found"},"example":["Contact with sourceId [25494] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/50006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ContactNotFound"}}}}},"examples":{"Delete Contact by lookup key - 404":{"value":{"error":{"code":50006,"messages":["Contact with sourceId [25494] not found"],"moreInfo":"https://www.propel.us/docs/errors/50006","status":404,"type":"ContactNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Contact Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-contact-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Contact Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/contacts/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing contact. The contact can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25492"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Contact Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:19:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"d012a8fc-9cfd-4cf3-837f-76e2e57e3d5e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Contact Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Contact Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 10:19:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"98f5a9e3-22fb-4aa9-b5f4-c6d55792f74c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":50007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Contact] with id [25494] not found"},"example":["Parent resource [Contact] with id [25494] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentContactNotFound"}}}}},"examples":{"Delete Contact Pricing - 404":{"value":{"error":{"code":50007,"messages":["Parent resource [Contact] with id [25494] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentContactNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Customer Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-customer-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Customer Address"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a customer address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106098"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Customer Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:43:54 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"146a579b-3111-41a7-9848-77256b920e7d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Address deleted"},"example":["Address deleted"]}}},"examples":{"Delete Customer Address - 200":{"value":{"data":{},"messages":["Address deleted"]}}}}}},"404":{"description":"Delete Customer Address - 404 (customer) / Delete Customer Address - 404 (address)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:43:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"2492b513-351e-4f4d-ae56-76727f50e9fd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Delete Customer Address - 404 (address)":{"value":{"error":{"code":90006,"messages":["Address with id [106100] not found for [Customers] with id [25494]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Delete Customer Address - 404 (customer)":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Customer by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-customer-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Customer by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/customers/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a `customer` by a specific lookupKey / lookupId combination. A deleted `customer` will be moved to the Propeller Recycle bin. This means the deleted customer can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25495"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Customer by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"45"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:47:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b9364c49-e0f6-4270-80a5-53f2b9d553f4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Customer deleted"},"example":["Customer deleted"]}}},"examples":{"Delete Customer by lookup key - 200":{"value":{"data":{},"messages":["Customer deleted"]}}}}}},"400":{"description":"Delete Customer by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:48:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a2d95d66-bb19-4d62-b071-81fd78f90682"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete Customer by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete Customer by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:47:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"eda29dbb-4b1a-4d55-aa29-62e97c8dd765"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60006},"messages":{"type":"array","items":{"type":"string","example":"Customer with sourceId [25496] not found"},"example":["Customer with sourceId [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CustomerNotFound"}}}}},"examples":{"Delete Customer by lookup key - 404":{"value":{"error":{"code":60006,"messages":["Customer with sourceId [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60006","status":404,"type":"CustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Customer Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-customer-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Customer Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/customers/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing customer. The customer can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User Pricing - 200 / Delete Customer Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:51:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e15dac3a-4e5f-4c80-958c-efa603817c73"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Customer Pricing - 200":{"value":{"data":{},"messages":["completed"]}},"Delete User Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete User Pricing - 404 / Delete Customer Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:51:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c723ab28-9af0-4ad6-8b7f-f4c1dc517f65"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [14699] not found"},"example":["Parent resource [User] with id [14699] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Delete Customer Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}},"Delete User Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [14699] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows deleting inventory record by it's Propeller inventory id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Inventory by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:04:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5ac2d4fc-9402-40fa-96cd-5593689b756a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Inventory deleted"},"example":["Inventory deleted"]}}},"examples":{"Delete Inventory by Id - 200":{"value":{"data":{},"messages":["Inventory deleted"]}}}}}},"404":{"description":"Delete Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 10:04:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6404936a-7275-4eaf-8b60-f12e3846d4b2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Delete Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a link by Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Link by Id 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"41"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 15:05:04 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Link deleted"},"example":["Link deleted"]}}},"examples":{"Delete Link by Id 200":{"value":{"data":{},"messages":["Link deleted"]}}}}}},"404":{"description":"Delete Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 15:05:18 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [485377] not found"},"example":["Link with id [485377] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Delete Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [485377] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"51"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:43:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f227705b-07ef-4c26-95f6-501459df0c3b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option deleted"},"example":["Cluster Option deleted"]}}},"examples":{"Delete Option by Cluster lookup key and Option Id - 200":{"value":{"data":{},"messages":["Cluster Option deleted"]}}}}}},"404":{"description":"Delete Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:43:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"03a4766d-9840-4e35-9f96-8ec2b675968b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [216] not found for the cluster with id [213]"},"example":["Cluster Option with id [216] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Delete Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [216] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Pricesheet by lookup id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-pricesheet-by-lookup-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Pricesheet by lookup id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/pricesheets/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint deletes a price sheet and it's pricing. The price sheet can be identified by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-v1/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Pricesheet by code - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:37:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e1f828f0-067d-4b98-bdbd-a79426881dc7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Pricesheet by code - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Pricesheet by code - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:40:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"adce4eff-80c0-4036-8f0b-35d573673bc1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12002},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet with code [3A221] not found"},"example":["Pricesheet with code [3A221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12002"},"status":{"type":"number","example":404},"type":{"type":"string","example":"PricesheetNotFound"}}}}},"examples":{"Delete Pricesheet by code - 404":{"value":{"error":{"code":12002,"messages":["Pricesheet with code [3A221] not found"],"moreInfo":"https://www.propel.us/docs/errors/12002","status":404,"type":"PricesheetNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Pricesheet Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-pricesheet-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Pricesheet Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/pricesheets/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for a given price sheet without actually deleting the price sheet. The price sheet is identified by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-v1/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Pricesheet Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:36:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4ccc3d95-2c3b-4919-ab74-53e6dbb46e00"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Pricesheet Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Pricesheet Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"200"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:37:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"cd235303-6610-4148-91a5-6773faf52479"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12005},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Pricesheets] with code [3A221] not found"},"example":["Parent resource [Pricesheets] with code [3A221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentPricesheetsNotFound"}}}}},"examples":{"Delete Pricesheet Pricing - 404":{"value":{"error":{"code":12005,"messages":["Parent resource [Pricesheets] with code [3A221] not found"],"moreInfo":"https://www.propel.us/docs/errors/12005","status":404,"type":"ParentPricesheetsNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"52"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:34:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"659e03d9-cc94-4a95-8bdd-acc5d9ca502b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product deleted"},"example":["Cluster Product deleted"]}}},"examples":{"Delete Product by Cluster lookup key and Product Id - 200":{"value":{"data":{},"messages":["Cluster Product deleted"]}}}}}},"404":{"description":"Delete Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:34:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"7f95d95f-dd02-40b3-9fc1-9df503518608"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707969] not found for the cluster with id [210]"},"example":["Cluster Product with id [707969] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Delete Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707969] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:24:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"27b7563c-4551-40a5-ba90-bf94e493dd33"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Product deleted"},"example":["Product deleted"]}}},"examples":{"Delete Product by Id - 200":{"value":{"data":{},"messages":["Product deleted"]}}}}}},"404":{"description":"Delete Product by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:22:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b9e159d2-8408-43a6-8447-640330bf2c84"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [48118] not found"},"example":["Product with id [48118] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Delete Product by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [48118] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Product translation by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-product-translation-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Product translation by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/products/{lookupKey}/{lookupValue}/translation/{translationLanguage}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete product translation by lookup key and the language for which the translation needs to be deleted. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"48118"},"description":"The value of the key (id, sourceId, sku or supplierCode)"},{"name":"translationLanguage","in":"path","required":true,"schema":{"type":"string","example":"FR"},"description":"The language to delete. Cannot be the default language of the category"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Product translation by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"48"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:14:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"99ac5897-caa2-4aef-bec2-b1e62303a95e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Translation deleted"},"example":["Translation deleted"]}}},"examples":{"Delete Product translation by Id - 200":{"value":{"data":{},"messages":["Translation deleted"]}}}}}},"404":{"description":"Delete Product translation by Id - 404 (Product not found) / Delete Product translation by Id - 404 (Translation not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 17:13:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bb654f7b-5ab0-42ae-91aa-04a4aacd98fc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [48118] not found"},"example":["Product with id [48118] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Delete Product translation by Id - 404 (Product not found)":{"value":{"error":{"code":80006,"messages":["Product with id [48118] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}},"Delete Product translation by Id - 404 (Translation not found)":{"value":{"error":{"code":10018,"messages":["[FR] translation for product with id [40360] not found"],"moreInfo":"https://www.propel.us/docs/errors/10018","status":404,"type":"TranslationNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User Address"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a user's address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Delete User Address":{"value":{"firstName":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User Address by Id - 200 / Delete User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"44"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 19:23:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"130478fb-d22e-45a6-90ed-1980abc20734"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Address deleted"},"example":["Address deleted"]}}},"examples":{"Delete User Address by Id - 200":{"value":{"data":{},"messages":["Address deleted"]}}}}}},"404":{"description":"Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found) / Delete Address by Id - 404 (user not found) / Delete Address by Id - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"195"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 19:22:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"50bca6e1-d150-4256-97a3-aa52d77a14a2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Delete User Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819189] not found for [Usergroup] with id [122]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Delete User Address by Id - 404 (user not found)":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a `user` by a specific lookupKey / lookupId combination. A deleted `user` will be moved to the Propeller Recycle bin. This means the deleted user can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User by Id  - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"41"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:24:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"65898282-b59a-4574-8c18-33be933da50c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"User deleted"},"example":["User deleted"]}}},"examples":{"Delete User by Id  - 200":{"value":{"data":{},"messages":["User deleted"]}}}}}},"400":{"description":"Delete User by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:25:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7e028deb-28d7-4109-a1fa-142c08fde08c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete User by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"167"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 19:25:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e89819f6-3aec-4e94-87b9-1e7828ad5f05"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with sourceId [146991] not found"},"example":["User with sourceId [146991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Delete User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with sourceId [146991] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete User Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-user-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete User Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/users/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing user. The user can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14718"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete User Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:29:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0081d0da-5b74-4ff7-9099-b350fceb20bd"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete User Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete User Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"186"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:26:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0259b0cd-14f1-4e4c-862e-96f54d5210a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [14699] not found"},"example":["Parent resource [User] with id [14699] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Delete User Pricing - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [14699] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a usergroup by a specific lookupKey / lookupId combination. A deleted usergroup will be moved to the Propeller Recycle bin. This means the deleted usergroup can be restored, however, only via the Propeller backoffice.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Usergroup by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"46"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:30:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8319c262-f4a5-478c-9f75-ea4fe0ac8f0b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup deleted"},"example":["Usergroup deleted"]}}},"examples":{"Delete Usergroup by Id - 200":{"value":{"data":{},"messages":["Usergroup deleted"]}}}}}},"400":{"description":"Delete Usergroup by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:34:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e918f7a3-5711-4366-a224-0f8f71e10c2f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Delete Usergroup by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Delete Usergroup by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:31:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2fbd9182-9077-41c6-8cae-9dca0fab89ad"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21317] not found"},"example":["Usergroup with id [21317] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Delete Usergroup by Id - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21317] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Delete Usergroup Pricing

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/delete-usergroup-pricing.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete Usergroup Pricing"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/usergroups/{lookupKey}/{lookupValue}/pricing"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete pricing for an existing usergroup. The usergroup can be identified by it's lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Delete Usergroup Pricing - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"38"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:42:50 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b695bd56-0a13-49d7-9213-ef5c80735da2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"completed"},"example":["completed"]}}},"examples":{"Delete Usergroup Pricing - 200":{"value":{"data":{},"messages":["completed"]}}}}}},"404":{"description":"Delete Usergroup Pricing - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"197"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 15:41:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"2fb9ab1b-d503-41ee-8aeb-4a00acd52df8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [122589] not found"},"example":["Parent resource [Usergroup] with id [122589] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Delete Usergroup Pricing - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [122589] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Add items to FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/add-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Add items to FavoriteList"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/favoritelists/{id}/add-items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Add items to FavoriteList

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList identifier","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"FavoriteList items input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"productSources":{"description":"List of product sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}}},"title":"FavoriteListsItemsInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Items added to FavoriteList","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown add items to FavoriteList error"}}}
>
  
</StatusCodes>

---

## Clear items from FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/clear-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Clear items from FavoriteList"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/favoritelists/{id}/clear-items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Clear items from FavoriteList

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList identifier","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}},{"name":"products","required":false,"in":"query","description":"Clear products","allowEmptyValue":false,"example":false,"schema":{"type":"boolean"}},{"name":"clusters","required":false,"in":"query","description":"Clear clusters","allowEmptyValue":false,"example":false,"schema":{"type":"boolean"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Items cleared from FavoriteList","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown clear items from FavoriteList error"}}}
>
  
</StatusCodes>

---

## Create a new FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/create-favorite-list.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a new FavoriteList"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/favoritelists"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new FavoriteList

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Create FavoriteList input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"productSources":{"description":"List of product sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"isDefault":{"type":"boolean","description":"Favorite List is default","example":false,"default":false},"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"companySource":{"description":"A company source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"contactSource":{"description":"A contact source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"customerSource":{"description":"A customer source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]}},"required":["isDefault","name"],"title":"FavoriteListsCreateInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"FavoriteList created","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"500":{"description":"Unknown create FavoriteList error"}}}
>
  
</StatusCodes>

---

## Delete a FavoriteList by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/delete-favorite-list.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete a FavoriteList by id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/favoritelists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a FavoriteList by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList id","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"FavoriteList deleted"},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown delete FavoriteList error"}}}
>
  
</StatusCodes>

---

## FavoriteLists API

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/favoritelists-api.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 0.4.0"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"FavoriteLists API"}
>
</Heading>



FavoriteLists API

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div><div
  style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
  <h3
    style={{"marginBottom":"0.25rem"}}
  >
    Contact
  </h3><span>
    Propeller: [cloud@propel.us](mailto:cloud@propel.us)
  </span><span>
    URL: [https://propeller-commerce.com](https://propeller-commerce.com)
  </span>
</div>

---

## Get a FavoriteList by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/get-favorite-list-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get a FavoriteList by id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/favoritelists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get a FavoriteList by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList identifier","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get a FavoriteList by id","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown get FavoriteList error"}}}
>
  
</StatusCodes>

---

## List FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/list-favorite-lists.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List FavoriteList"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/favoritelists"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List FavoriteList

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","required":false,"in":"query","description":"Pagination page number","allowEmptyValue":false,"schema":{"default":1},"example":1},{"name":"offset","required":false,"in":"query","description":"Pagination offset number","allowEmptyValue":false,"schema":{"default":12},"example":12},{"name":"name","required":false,"in":"query","description":"Favorite List name","allowEmptyValue":false,"example":"MyFavoriteList","schema":{"type":"string"}},{"name":"isDefault","required":false,"in":"query","description":"Favorite List is default","allowEmptyValue":false,"example":true,"schema":{"type":"boolean"}},{"name":"companyId","required":false,"in":"query","description":"Favorite List company ID","allowEmptyValue":false,"example":1234,"schema":{"type":"integer"}},{"name":"contactId","required":false,"in":"query","description":"Favorite List contact ID","allowEmptyValue":false,"example":1234,"schema":{"type":"integer"}},{"name":"customerId","required":false,"in":"query","description":"Favorite List customer ID","allowEmptyValue":false,"example":1234,"schema":{"type":"integer"}},{"name":"productIds","required":false,"in":"query","description":"List of product ids","allowEmptyValue":false,"example":[1234,5678],"schema":{"type":"array","items":{"type":"integer"}}},{"name":"clusterIds","required":false,"in":"query","description":"List of cluster ids","allowEmptyValue":false,"example":[1234,5678],"schema":{"type":"array","items":{"type":"integer"}}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Paginated list of FavoriteList","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type FavoriteListDto","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"FavoriteListsResponseDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden."},"500":{"description":"Unknown get FavoriteList error"}}}
>
  
</StatusCodes>

---

## Remove items from a FavoriteList

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/remove-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove items from a FavoriteList"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/favoritelists/{id}/remove-items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Remove items from a FavoriteList

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList identifier","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"FavoriteList items input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"productSources":{"description":"List of product sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}}},"title":"FavoriteListsItemsInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Items removed from a FavoriteList","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown remove items from FavoriteList error"}}}
>
  
</StatusCodes>

---

## Search Favorite Lists

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/search-favorite-lists.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Favorite Lists"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/favoritelists/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Search Favorite Lists

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Search orderlists. Use either an id or a source","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"companySource":{"description":"A company source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"contactSource":{"description":"A contact source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"customerSource":{"description":"A customer source","example":{"name":"Source","id":"Source 1"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"SourceInput"}]},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"productSources":{"description":"List of product sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}}},"title":"FavoriteListsSearchInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Paginated list of FavoriteLists","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type FavoriteListDto","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"FavoriteListsResponseDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden."},"500":{"description":"Unknown search FavoriteList error"}}}
>
  
</StatusCodes>

---

## Update a FavoriteList by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/favoritelists/update-favorite-list.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a FavoriteList by id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/favoritelists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update a FavoriteList by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"FavoriteList identifier","example":"60f1b9b3b3b3b3b3b3b3b3b3","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Update FavoriteList input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"productSources":{"description":"List of product sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"integer"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"Source","id":"Source 1"}],"type":"array","items":{"type":"string"}},"isDefault":{"type":"boolean","description":"Favorite List is default","example":false,"default":false},"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64}},"required":["isDefault"],"title":"FavoriteListsUpdateInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"FavoriteList updated","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Favorite List name","example":"MyFavoriteList","maxLength":64},"companyId":{"type":"int","description":"Favorite List company ID","example":1111},"contactId":{"type":"int","description":"Favorite List contact ID","example":1111},"customerId":{"type":"int","description":"Favorite List customer ID","example":1111},"productIds":{"description":"Favorite List product IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"clusterIds":{"description":"Favorite List cluster IDs list","example":[1111,2222,3333],"type":"array","items":{"type":"number"}},"isDefault":{"type":"boolean","description":"Default Favorite List","example":true},"slug":{"type":"string","description":"Favorite List slug","example":"my-favorite-list-slug"},"createdAt":{"type":"date","description":"Favorite List date created","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"updatedAt":{"type":"date","description":"Favorite List date modified","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"id":{"type":"string","description":"Favorite List identifier","example":"64e896addf2137b255101f49"}},"required":["name","isDefault","slug","id"],"title":"FavoriteListDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"FavoriteList not found"},"500":{"description":"Unknown update FavoriteList error"}}}
>
  
</StatusCodes>

---

## Get Access Token

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-access-token.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Access Token"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve an access token for accessing the REST APIs.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"grant_type":{"type":"string","default":"client_credentials","example":"client_credentials"}}},"examples":{"Get Access Token":{"value":{"grant_type":"client_credentials"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Access Token - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"589"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:55:16 GMT"}},"x-request-id":{"schema":{"type":"string","example":"bf951b46-1e6d-4f2a-b5e6-b87281df731b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string","example":"ARAo4GjuI1bGSyenSKx5oYfFGuFQ"},"api_product_list":{"type":"string","example":"[Propeller REST APIs]"},"api_product_list_json":{"type":"array","items":{"type":"string","example":"Propeller REST APIs"},"example":["Propeller REST APIs"]},"application_name":{"type":"string","example":"a1ca275a-2abb-4bd3-82b0-3ae699d75e40"},"client_id":{"type":"string","example":"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT"},"developer.email":{"type":"string","example":"developer@propel.us"},"expires_in":{"type":"string","example":"1899"},"issued_at":{"type":"string","example":"1646873717224"},"organization_name":{"type":"string","example":"propeller-platform-prod"},"refresh_count":{"type":"string","example":"0"},"refresh_token_expires_in":{"type":"string","example":"0"},"scope":{"type":"string","example":""},"status":{"type":"string","example":"approved"},"token_type":{"type":"string","example":"BearerToken"}}},"examples":{"Get Access Token - 200":{"value":{"access_token":"ARAo4GjuI1bGSyenSKx5oYfFGuFQ","api_product_list":"[Propeller REST APIs]","api_product_list_json":["Propeller REST APIs"],"application_name":"a1ca275a-2abb-4bd3-82b0-3ae699d75e40","client_id":"veNqlG9u5JAce1AccAnuiqxFL1NvVMHS0H8Qu8omHBW7ykjT","developer.email":"developer@propel.us","expires_in":"1899","issued_at":"1646873717224","organization_name":"propeller-platform-prod","refresh_count":"0","refresh_token_expires_in":"0","scope":"","status":"approved","token_type":"BearerToken"}}}}}},"400":{"description":"Get Access Token - 400 (invalid body value)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"90"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:59:09 GMT"}},"x-request-id":{"schema":{"type":"string","example":"4c0191c8-50f7-43c5-952d-a340bcef7208"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"Error":{"type":"string","example":"Unsupported grant type : client_credentials1"},"ErrorCode":{"type":"string","example":"invalid_request"}}},"examples":{"Get Access Token - 400 (invalid body value)":{"value":{"Error":"Unsupported grant type : client_credentials1","ErrorCode":"invalid_request"}}}}}},"401":{"description":"Get Access Token - 401 (wrong client id / client secret)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google"}},"content-length":{"schema":{"type":"string","example":"64"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 00:58:18 GMT"}},"x-request-id":{"schema":{"type":"string","example":"c75881bb-a9b1-4258-922d-a8053fa1c661"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"Error":{"type":"string","example":"ClientId is Invalid"},"ErrorCode":{"type":"string","example":"invalid_client"}}},"examples":{"Get Access Token - 401 (wrong client id / client secret)":{"value":{"Error":"ClientId is Invalid","ErrorCode":"invalid_client"}}}}}}}}
>
  
</StatusCodes>

---

## Get Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-addresses-by-type-1.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all order addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"possible values:\n\ndelivery\ninvoice"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order "}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Delivery Addresses - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"795"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:18:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"02c6664d-aa51-4758-bc86-082f9e5d9360"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"w.spies@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}},"example":[{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Delivery Addresses - 200":{"value":{"data":[{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}],"messages":[],"total":2}}}}}},"404":{"description":"Get Delivery Addresses - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:12:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"bab637cc-d756-4eb9-9a3e-f27c648230e0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Get Delivery Addresses - 404":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all company addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Addresses by type - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"892"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:56:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"275bd3cd-ca81-4362-b495-344a198e551d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106076},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106076,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106078,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Addresses by type - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106076,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106078,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"}],"messages":[],"total":2}}}}}},"404":{"description":"Get Addresses by type - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"189"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:56:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c1189111-8b0e-46f5-b2fd-6e096e05620a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Get Addresses by type - 404":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to retrieve details of an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get attribute by Id - 200 / Get attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"403"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:58:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"026fec00-dafe-43bb-843d-d84cfd590683"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"defaultLanguage":{"type":"string","example":"EN"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Color"}}},"example":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"COLOR"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"COLORS"},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":""}}},"example":[{"language":"EN","value":""},{"language":"NL","value":""}]},"value":{"example":"","anyOf":[{"type":"string","example":""},{"type":"array","items":{},"example":[]}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get attribute by Id - 200":{"value":{"data":{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""},"messages":[],"total":1}},"Get attribute by name and class - 200":{"value":{"data":{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"Framemateriaal"},{"language":"EN","value":"Frame material"}],"group":"","id":85,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"MATERIAAL_FRAME","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""}],"value":[]},"messages":[],"total":1}}}}}},"404":{"description":"Get attribute by Id - 404 / Get attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"213"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 14:59:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7a690144-65d6-40f8-8d8b-0ce4589da991"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [800] not found."},"example":["Attribute with id [800] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Get attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [800] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Get attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [MATERIAAL_FRAME] and attributeClass [category] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-attributes.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get attributes"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint can be used to list all existing attributes. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number. integer, optional (default: 1)"},{"name":"offset","in":"query","schema":{"type":"string","example":"20"},"description":"Number of results per page. integer, optional (default: 20)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get attributes - 200 (with results) / Get attributes - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"98"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:33:22 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"94282b6d-d35a-4285-bb10-897622ead1cb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"project"},"defaultLanguage":{"type":"string","example":"NL"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"PROPELLOR_PLUSPUNT_1"}}},"example":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":1},"isHidden":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isPublic":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isSearchable":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"isSystem":{"example":"N","anyOf":[{"type":"string","example":"N"},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false},{"type":"boolean","example":false}]},"name":{"type":"string","example":"AUTOMATIC_BILLING"},"type":{"type":"string","example":"enum"},"typeParam":{"type":"string","example":"AUTOMATIC_BILLING"},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"value":{"type":"array","items":{},"example":[]}}},"example":[{"class":"project","defaultLanguage":"NL","group":"","id":1,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":2,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":3,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":4,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"project","defaultLanguage":"NL","group":"","id":5,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":6,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":7,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":8,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}],"group":"","id":11,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_2"}],"group":"","id":12,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_3"}],"group":"","id":13,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_4"}],"group":"","id":15,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_5"}],"group":"","id":16,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_5","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_6"}],"group":"","id":17,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_6","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_7"}],"group":"","id":18,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_7","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_8"}],"group":"","id":19,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_8","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_1"},{"language":"EN","value":"PROPELLOR_MINPUNT_1"},{"language":"FR","value":"PROPELLOR_MINPUNT_1"}],"group":"","id":20,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""},{"language":"FR","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_2"}],"group":"","id":21,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_3"}],"group":"","id":22,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_4"}],"group":"","id":23,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]}]},"end":{"type":"number","example":20},"itemsFound":{"type":"number","example":208},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":20},"page":{"type":"number","example":1},"pages":{"type":"number","example":11},"start":{"type":"number","example":1},"total":{"type":"number","example":20}}},"examples":{"Get attributes - 200 (no results)":{"value":{"data":[],"itemsFound":208,"messages":["Completed"],"offset":20,"page":15,"pages":11,"total":1}},"Get attributes - 200 (with results)":{"value":{"data":[{"class":"project","defaultLanguage":"NL","group":"","id":1,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":2,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":3,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":4,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"project","defaultLanguage":"NL","group":"","id":5,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"AUTOMATIC_BILLING","type":"enum","typeParam":"AUTOMATIC_BILLING"},{"class":"project","defaultLanguage":"NL","group":"","id":6,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_INTO_INVOICE","type":"enum","typeParam":"BILLABLE_HOURS_INTO_INVOICE"},{"class":"project","defaultLanguage":"NL","group":"","id":7,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"BILLABLE_HOURS_RATE_TYPE","type":"enum","typeParam":"BILLABLE_HOURS_RATE_TYPE"},{"class":"project","defaultLanguage":"NL","group":"","id":8,"isHidden":"N","isPublic":"N","isSearchable":"N","isSystem":"N","name":"SEND_TICKET_ACTIVITY","type":"enum","typeParam":"SEND_TICKET_ACTIVITY"},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_1"}],"group":"","id":11,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_2"}],"group":"","id":12,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_3"}],"group":"","id":13,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_4"}],"group":"","id":15,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_5"}],"group":"","id":16,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_5","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_6"}],"group":"","id":17,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_6","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_7"}],"group":"","id":18,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_7","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_PLUSPUNT_8"}],"group":"","id":19,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_PLUSPUNT_8","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_1"},{"language":"EN","value":"PROPELLOR_MINPUNT_1"},{"language":"FR","value":"PROPELLOR_MINPUNT_1"}],"group":"","id":20,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_1","type":"text","typeParam":"","units":[{"language":"NL","value":""},{"language":"EN","value":""},{"language":"FR","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_2"}],"group":"","id":21,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_2","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_3"}],"group":"","id":22,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_3","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]},{"class":"product","defaultLanguage":"NL","descriptions":[{"language":"NL","value":"PROPELLOR_MINPUNT_4"}],"group":"","id":23,"isHidden":false,"isPublic":false,"isSearchable":false,"isSystem":false,"name":"PROPELLOR_MINPUNT_4","type":"text","typeParam":"","units":[{"language":"NL","value":""}],"value":[]}],"end":20,"itemsFound":208,"messages":["Completed"],"offset":20,"page":1,"pages":11,"start":1,"total":20}}}}}},"400":{"description":"Get attributes - 400 (invalid offset)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:34:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e7215195-6372-4222-ad37-40974a53b10b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10015},"messages":{"type":"array","items":{"type":"string","example":"Offset cannot be more than 100"},"example":["Offset cannot be more than 100"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10015"},"status":{"type":"number","example":400},"type":{"type":"string","example":"PaginatedResponseException"}}}}},"examples":{"Get attributes - 400 (invalid offset)":{"value":{"error":{"code":10015,"messages":["Offset cannot be more than 100"],"moreInfo":"https://www.propel.us/docs/errors/10015","status":400,"type":"PaginatedResponseException"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"expands","in":"query","schema":{"type":"string","example":"translation"},"description":"Use `translation` when retrieving translated fields in all languages. By default, only the default language of the category will be provided. [What is resource expanding?](#expanding-resources)"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"296"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:35:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b2659cec-8785-495f-a30e-7e94d7558c65"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1787},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Category by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1787,"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Category by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"173"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:12:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c768dcde-4761-49b4-b233-2c69213793a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [1771] not found"},"example":["Category with sourceId [1771] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Get Category by sourceId - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [1771] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster details by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,parent,defaultProduct,options,products,clusterConfig"},"description":"Optional.  Use `options` to retrieve the cluster options. Use `products` to retrive cluster products etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Cluster by lookup key - 200 / Get Cluster by lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2436"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:59:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"fe172ee4-a8c9-446e-9e22-bd9a36a53e3b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfig":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"OPTIONS_CLUSTER"},"settings":{"type":"array","items":{},"example":[]}}},"code":{"type":"string","example":"15120300"},"defaultobject_id":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"id":{"type":"number","example":210},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"}]},"options":{"type":"array","items":{"type":"object","properties":{"defaultProduct":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"id":{"type":"number","example":214},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]}}},"example":[{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]},{"defaultProduct":"","descriptions":[{"language":"NL","value":"Toetsenbord"}],"id":216,"isRequired":false,"names":[{"language":"NL","value":"Toetsenbord"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"KM636000"}]}]},"parent":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"id":{"type":"number","example":23409},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Clusters"}}},"example":[{"language":"NL","value":"Clusters"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"CLUSTERS"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"CLUSTERS"}]}}},"products":{"type":"array","items":{"type":"object","properties":{"costPrice":{"type":"number","example":400},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}}},"example":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707971},"manufacturer":{"type":"string","example":"DELL"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"DELL Precision 5530 Laptop - Z"}}},"example":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"base cluster product"}}},"example":[{"language":"NL","value":"base cluster product"}]},"oemCode":{"type":"string","example":"FYR88"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":555},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"DELL Precision 5530 Laptop - Z"}}},"example":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}]},"shortName":{"type":"string","example":"DELL Precision 5530 Laptop"},"sku":{"type":"string","example":"FYR88"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"FYR88"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}]},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":555},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"FYR88"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}},"example":[{"costPrice":400,"descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"eanCode":"4004675044075","id":707971,"manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"notes":[{"language":"NL","value":"base cluster product"}],"oemCode":"FYR88","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":555,"shortDescriptions":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"shortName":"DELL Precision 5530 Laptop","sku":"FYR88","sources":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}],"status":"A","suggestedPrice":555,"supplier":"REST-API","supplierCode":"FYR88","taxCode":"H","taxPercentage":0.21,"unit":1}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"CO.FYR88"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"CO.FYR88"},{"language":"NL","source":"REST-API","sourceId":"COFYR88"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Cluster by lookup key - 200":{"value":{"data":{"clusterConfig":{"id":11},"code":"15120300","defaultobject_id":"","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"id":210,"names":[{"language":"NL","value":"Balpen Slider XB extra"}],"shortDescriptions":[{"language":"NL","value":""}]},"messages":[],"total":1}},"Get Cluster by lookup key - 200 (expands)":{"value":{"data":{"clusterConfig":{"id":12,"name":"OPTIONS_CLUSTER","settings":[]},"code":"CO.FYR88","defaultobject_id":"","descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"id":213,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"options":[{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"},{"language":"NL","source":"REST-API","sourceId":"K72334000"}]},{"defaultProduct":"","descriptions":[{"language":"NL","value":"Toetsenbord"}],"id":216,"isRequired":false,"names":[{"language":"NL","value":"Toetsenbord"}],"shortDescriptions":[{"language":"NL","value":"Toetsenbord"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"KM636000"}]}],"parent":{"descriptions":[{"language":"NL","value":""}],"id":23409,"names":[{"language":"NL","value":"Clusters"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[{"language":"NL","source":"REST-API","sourceId":"CLUSTERS"}]},"products":[{"costPrice":400,"descriptions":[{"language":"NL","value":"39.624 cm (15.6) FHD (1920 x 1080), Intel Core i7-8850H (9M Cache, up to 4.30 GHz), Intel UHD Graphics 630 + Nvidia Quadro P1000 4 GB, 8 GB DDR4 2666 MHz, 256 GB SSD, WLAN, Bluetooth, Windows 10 Pro 64-bit"}],"eanCode":"4004675044075","id":707971,"manufacturer":"DELL","minimumQuantity":1,"names":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"notes":[{"language":"NL","value":"base cluster product"}],"oemCode":"FYR88","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":555,"shortDescriptions":[{"language":"NL","value":"DELL Precision 5530 Laptop - Z"}],"shortName":"DELL Precision 5530 Laptop","sku":"FYR88","sources":[{"language":"NL","source":"REST-API","sourceId":"FYR88"}],"status":"A","suggestedPrice":555,"supplier":"REST-API","supplierCode":"FYR88","taxCode":"H","taxPercentage":0.21,"unit":1}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[{"language":"NL","source":"REST-API","sourceId":"CO.FYR88"},{"language":"NL","source":"REST-API","sourceId":"COFYR88"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"164"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:21:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bac16e57-eac8-47eb-a2cf-3ce012b14f1f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [211] not found"},"example":["Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Get Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Cluster Config by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-cluster-config-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Cluster Config by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster config details by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"settings"},"description":"Optional.  Use `settings` to retrieve the settings details of the cluster config."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"8"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Cluster Config by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"184"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:51:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b8925b84-12db-4723-9022-c28943b7f16b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":11},"name":{"type":"string","example":"LINEAR_CLUSTER"},"settings":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","example":"PROPELLER_COLOR"},"clusterConfigId":{"type":"number","example":11},"displayType":{"type":"string","example":"color"},"id":{"type":"number","example":115},"priority":{"type":"string","example":"1"}}},"example":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":"1"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Cluster Config by lookup key - 200":{"value":{"data":{"id":11,"name":"LINEAR_CLUSTER","settings":[{"attributeName":"PROPELLER_COLOR","clusterConfigId":11,"displayType":"color","id":115,"priority":"1"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Cluster Config by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"176"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:51:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"0db5a3b1-69a8-489f-b828-1dc50c96cfd5"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21005},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with id [12] not found"},"example":["Cluster Config with id [12] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigNotFound"}}}}},"examples":{"Get Cluster Config by lookup key - 404":{"value":{"error":{"code":21005,"messages":["Cluster Config with id [12] not found"],"moreInfo":"https://www.propel.us/docs/errors/21005","status":404,"type":"ClusterConfigNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Company Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-company-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Company Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a company address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106078"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Company Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"463"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:58:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"56d32679-6c95-4870-bf16-f6c0e1de8088"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106076},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Company Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106076,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get Company Address by Id - 404 (company) / Get Company Address by Id - 404 (address)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:00:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a00e5334-958b-4baa-8467-a366fca2cc24"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Company] with id [9484] not found"},"example":["Parent resource [Company] with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCompanyNotFound"}}}}},"examples":{"Get Company Address by Id - 404 (address)":{"value":{"error":{"code":90006,"messages":["Address with id [106200] not found for [Companies] with id [9482]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Company Address by Id - 404 (company)":{"value":{"error":{"code":40007,"messages":["Parent resource [Company] with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40007","status":404,"type":"ParentCompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Company by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-company-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Company by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/companies/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve company details by lookup key. If multiple companies with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the company (e.g. `source` and `language` for lookup key `sourceId`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for companies like sources, etc.\n\n`sources`: if the `expands` parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a company can be a resource of type `usergroup`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"646"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Company by lookup key - 200 / Get Company by lookup key - 200 (expand: sources)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"399"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:16:44 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b6c22f97-93ed-4b6d-a7cf-8a56a8bc4c1f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"cocNumber":{"type":"string","example":"75564998"},"company":{"type":"string","example":""},"debtorId":{"type":"string","example":"75564998"},"defaultobjectId":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":151},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Company created from API"},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"taxNumber":{"type":"string","example":"NL860325386B01"},"userManagerId":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Company by lookup key - 200":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"75564998","company":"","debtorId":"75564998","defaultobjectId":"","department":"","id":151,"inheritOrderList":"N","inheritProductList":"Y","name":"Propeller B.V.","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"NL860325386B01","userManagerId":""},"messages":[],"total":1}},"Get Company by lookup key - 200 (expand: sources)":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"75564998","company":"","defaultobjectId":"","department":"","id":151,"inheritOrderList":"N","inheritProductList":"Y","name":"Propeller B.V.","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"taxNumber":"NL860325386B01","userManagerId":""},"messages":[],"total":1}}}}}},"400":{"description":"Get Company by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:19:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"140fb9e3-3b63-40ba-87ce-24eb5f43d78e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Company by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Company by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"165"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:18:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"90dff1a1-c30e-4848-aee6-2b7c63210802"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40006},"messages":{"type":"array","items":{"type":"string","example":"Company with id [9483] not found"},"example":["Company with id [9483] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CompanyNotFound"}}}}},"examples":{"Get Company by lookup key - 404":{"value":{"error":{"code":40006,"messages":["Company with id [9483] not found"],"moreInfo":"https://www.propel.us/docs/errors/40006","status":404,"type":"CompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Contact by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-contact-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Contact by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/contacts/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve contact details by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. `source` and `language` for lookup key `sourceId`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources,parent"},"description":"Use `expands` as a query parameter to fetch additional information for contacts like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a contact can be a resource of type `company`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25493"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Contact by lookup key - 200 / Get Contact by lookup key - 200 (expands: sources,parent)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"866"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:35:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c1bf4dfd-e7fb-4ce6-9a1c-d0788cc53971"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25492},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":"Miles McCoy"},"parent":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"company":{"type":"string","example":""},"defaultobjectId":{"type":"number","example":944644},"department":{"type":"string","example":""},"id":{"type":"number","example":9482},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Propeller B.V."},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"taxNumber":{"type":"string","example":"NL860325386B01"},"userManagerId":{"type":"string","example":""}}},"phone":{"type":"string","example":"0032445888"},"pricelistAmount":{"type":"string","example":""},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":"EN"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"3002196"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"3002196"}]},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Contact by lookup key - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25492,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},"messages":[],"total":1}},"Get Contact by lookup key - 200 (expands: sources,parent)":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25492,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","parent":{"authorizeId":"","budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"","defaultobjectId":944644,"department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","name":"Propeller B.V.","notes":"Usergroup created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"taxNumber":"NL860325386B01","userManagerId":""},"phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","sources":[{"language":"NL","source":"REST-API","sourceId":"3002196"}],"ssn":"","title":"Mr."},"messages":[],"total":1}}}}}},"400":{"description":"Get Contact by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:37:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"17d9f411-a8f1-4293-873c-db345aa644ec"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Contact by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Contact by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:36:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f066cdf7-3297-40e7-8098-0d13ae0bf9d7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":50006},"messages":{"type":"array","items":{"type":"string","example":"Contact with id [25493] not found"},"example":["Contact with id [25493] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/50006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ContactNotFound"}}}}},"examples":{"Get Contact by lookup key - 404":{"value":{"error":{"code":50006,"messages":["Contact with id [25493] not found"],"moreInfo":"https://www.propel.us/docs/errors/50006","status":404,"type":"ContactNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Customer Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-customer-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Customer Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a customer address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106098"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Customer Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"457"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:08:18 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"7e072971-c489-4dde-b675-570fcd6a1ed2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106099},"isDefault":{"type":"string","example":"Y"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Customer Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106099,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get Customer Address by Id - 404 (customer) / Get Customer Address by Id - 404 (address)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"199"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:09:10 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"382b91a4-7f89-47df-9b81-cf0892d2adc1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Get Customer Address by Id - 404 (address)":{"value":{"error":{"code":90006,"messages":["Address with id [106055] not found for [Customers] with id [25494]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Customer Address by Id - 404 (customer)":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Customer Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-customer-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Customer Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all customer addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Customer Addresses by type - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"1315"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:06:12 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"5dccfb6e-3282-4ef5-9a0b-6e40fbd1b0ff"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":106097},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106097,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106098,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Arnhem","code":"11234","company":"","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106099,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":3}}},"examples":{"Get Customer Addresses by type - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106097,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Amsterdam","code":"11235","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106098,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"","number":"193","numberExtension":"A","phone":"0032445888","postalCode":"1016 XA","region":"","street":"Lijnbaansgracht","type":"delivery","url":"www.propel.us"},{"active":"Y","city":"Arnhem","code":"11234","company":"","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":106099,"isDefault":"Y","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}],"messages":[],"total":3}}}}}},"404":{"description":"Get Customer Addresses by type - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:06:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"eb9e8d2a-60b5-4ff9-98e2-df8ca8f2222a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Get Customer Addresses by type - 404":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Customer by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-customer-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Customer by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/customers/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve customer details by lookup key. If multiple customers with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the customer (e.g. `source` and `language` for lookup key `sourceId`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources,parent"},"description":"Use `expands` as a query parameter to fetch additional information for customers like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a customer can be a resource of type `usergroup`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25495"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Customer by lookup key - 200 / Get Customer by lookup key - 200 (expands: sources,parent)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"944"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:40:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"495769da-c295-4300-b06a-6209896d4e56"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25494},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":"Miles McCoy"},"parent":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":"Trimergo"},"defaultobjectId":{"type":"number","example":227298},"department":{"type":"string","example":""},"id":{"type":"number","example":109},"inheritOrderList":{"type":"string","example":"Y"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Customer root"},"notes":{"type":"string","example":""},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"RCEB0451-3"},"sourceId":{"type":"string","example":"199605"}}},"example":[{"language":"NL","source":"RCEB0451-3","sourceId":"199605"},{"language":"NL","source":"OTTEVANGER-TRIMERGO","sourceId":"OTTEVANGER-TRIMERGO-CRM-ROOT"}]},"userManagerId":{"type":"string","example":""}}},"phone":{"type":"string","example":"0032445888"},"pricelistAmount":{"type":"string","example":""},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":"EN"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"3004196"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"3004196"}]},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Customer by lookup key - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25494,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},"messages":[],"total":1}},"Get Customer by lookup key - 200 (expands: sources,parent)":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25494,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","parent":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Trimergo","defaultobjectId":227298,"department":"","id":109,"inheritOrderList":"Y","inheritProductList":"Y","name":"Customer root","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[{"language":"NL","source":"RCEB0451-3","sourceId":"199605"},{"language":"NL","source":"OTTEVANGER-TRIMERGO","sourceId":"OTTEVANGER-TRIMERGO-CRM-ROOT"}],"userManagerId":""},"phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","sources":[{"language":"NL","source":"REST-API","sourceId":"3004196"}],"ssn":"","title":"Mr."},"messages":[],"total":1}}}}}},"400":{"description":"Get Customer by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:41:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b13165aa-cd34-4d5e-b98a-13576faffc26"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Customer by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Customer by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"168"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:41:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3a97afbc-b68c-4630-928d-634a9bfabcf9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60006},"messages":{"type":"array","items":{"type":"string","example":"Customer with id [25495] not found"},"example":["Customer with id [25495] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CustomerNotFound"}}}}},"examples":{"Get Customer by lookup key - 404":{"value":{"error":{"code":60006,"messages":["Customer with id [25495] not found"],"moreInfo":"https://www.propel.us/docs/errors/60006","status":404,"type":"CustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint is used to get an inventory data via it's unique inventory record Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Inventory by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"273"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 09:29:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e6c6fd2d-baeb-4cf1-ae6e-cefe5b825513"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":0},"dateModified":{"type":"string","example":"2022-02-21T12:52:38"},"id":{"type":"number","example":16141},"location":{"type":"string","example":""},"nextDeliveryDate":{"type":"string","example":"2021-02-25T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":37232},"quantity":{"type":"number","example":15},"sku":{"type":"string","example":"757540"},"supplier":{"type":"string","example":"QUANTORE"},"supplierCode":{"type":"string","example":"757540"},"usergroupId":{"type":"number","example":143},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Inventory by Id - 200":{"value":{"data":{"companyId":0,"costPrice":0,"dateModified":"2022-02-21T12:52:38","id":16141,"location":"","nextDeliveryDate":"2021-02-25T00:00:00","notes":"","productId":37232,"quantity":15,"sku":"757540","supplier":"QUANTORE","supplierCode":"757540","usergroupId":143,"warehouseId":4},"messages":[],"total":1}}}}}},"404":{"description":"Get Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 09:31:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"07314bc9-feee-4d00-98e6-5833bc3808e9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Get Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve link details by link id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Link by Id - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"250"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:53:08 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dateChanged":{"type":"string","example":"2018-11-08T11:35:38"},"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":24603}}},"id":{"type":"number","example":485377},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":false},"priority":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":27401}}},"type":{"type":"string","example":"accessories"}}},"example":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Link by Id - 200":{"value":{"data":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"}],"messages":[],"total":1}}}}}},"404":{"description":"Get Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:53:33 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [731085] not found"},"example":["Link with id [731085] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Get Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [731085] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to get details of single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,defaultProduct"}},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"examples":{"Get Option by Cluster lookup key and Option Id":{"value":""}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"301"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:38:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b5442c50-e266-4d74-8d8e-cb6740b865f9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"defaultProduct":{"type":"string","example":""},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"id":{"type":"number","example":214},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"}]},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"K72334"}]}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Option by Cluster lookup key and Option Id - 200":{"value":{"data":{"defaultProduct":"","descriptions":[{"language":"NL","value":"Muis"}],"id":214,"isRequired":false,"names":[{"language":"NL","value":"Muis"}],"shortDescriptions":[{"language":"NL","value":"Muis"}],"sources":[{"language":"NL","source":"REST-API","sourceId":"K72334"}]},"messages":[],"total":1}}}}}},"404":{"description":"Get Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:38:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"10b7cdcc-c009-43fe-9c84-c18123fd5f68"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [215] not found for the cluster with id [213]"},"example":["Cluster Option with id [215] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Get Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [215] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Options by Cluster lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-options-by-cluster-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Options by Cluster lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/options"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster options by cluster lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,defaultProduct"},"description":"Optional.  Use `translation` to retrieve the cluster options translations. Use `defaultProduct` to retrive cluster options default products etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"89"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Options by Cluster lookup key / Get Options by Cluster lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"1516"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:24:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"ff42f492-4f67-46b0-a82c-2a3db1d62f15"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"defaultProduct":{"type":"object","properties":{"id":{"type":"number","example":450102}}},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]},"id":{"type":"number","example":90},"isRequired":{"type":"boolean","example":true},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"First option"}}},"example":[{"language":"NL","value":"First option"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":""}}},"example":[{"language":"NL","value":""}]}}},"example":[{"defaultProduct":{"id":450102},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}]},{"defaultProduct":{"id":661190},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}]}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Options by Cluster lookup key":{"value":{"data":[{"defaultProduct":{"id":450102},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}]},{"defaultProduct":{"id":661190},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}]}],"messages":[],"total":2}},"Get Options by Cluster lookup key - 200 (expands)":{"value":{"data":[{"defaultProduct":{"costPrice":0,"descriptions":[{"language":"NL","value":""}],"eanCode":"","id":450102,"manufacturer":"","minimumQuantity":1,"names":[{"language":"NL","value":"My first option"}],"notes":[{"language":"NL","value":""}],"oemCode":"","package":"","packageDescriptions":[{"language":"NL","value":""}],"price":12,"shortDescriptions":[{"language":"NL","value":"<p>test change</p>\r\n"}],"shortName":"","sku":"conf-first-option-1","sources":[],"status":"A","suggestedPrice":0,"supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"unit":1},"descriptions":[{"language":"NL","value":""}],"id":90,"isRequired":true,"names":[{"language":"NL","value":"First option"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[]},{"defaultProduct":{"costPrice":0,"descriptions":[{"language":"NL","value":""}],"eanCode":"","id":661190,"manufacturer":"","minimumQuantity":1,"names":[{"language":"NL","value":"My second option"}],"notes":[{"language":"NL","value":""}],"oemCode":"","package":"","packageDescriptions":[{"language":"NL","value":""}],"price":0,"shortDescriptions":[{"language":"NL","value":""}],"shortName":"","sku":"conf-second-option-2","sources":[],"status":"A","suggestedPrice":0,"supplier":"","supplierCode":"","taxCode":"H","taxPercentage":21,"unit":1},"descriptions":[{"language":"NL","value":""}],"id":104,"isRequired":false,"names":[{"language":"NL","value":"Second option"}],"shortDescriptions":[{"language":"NL","value":""}],"sources":[]}],"messages":[],"total":2}}}}}},"404":{"description":"Get Options by Cluster lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:25:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"77b46b5a-6353-4512-86e0-ba98b6e83793"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [211] not found"},"example":["Parent Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Get Options by Cluster lookup key - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Order Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-order-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Order Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for an order address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81902"},"description":"Address Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Order Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"428"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:32:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f4778ede-9757-4f1e-9f18-bb9d66589804"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"julien@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Order Address by Id - 200":{"value":{"data":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"julien@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""},"messages":[],"total":1}}}}}},"404":{"description":"Get Order Address by Id - 404 (order not found) / Get Order Address by Id - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:32:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4e308b90-bc3a-44ad-9fda-a01dd9941af1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Get Order Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819021] not found for [Order] with id [195]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Order Address by Id - 404 (order not found)":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Pricesheet by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-pricesheet-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Pricesheet by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/pricesheets/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve price sheet details by lookup key. The `expands` parameter can be used to retrieve the pricing for the price sheet.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"products,categories"},"description":"Optional. Use `products` and/ or `categories` to retrieve the pricing defined on product/ category level. By default, no pricing will be retrieved. \n\n[What is resource expanding?](#expanding-resources)"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"code"},"description":"Lookup key. Read [more](/reference/legacy/rest-v1/pricesheets/#price-sheet-lookup-keys) about price sheet lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"3A22"},"description":"The value of the key (id or code)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Pricesheet by code - 200 (expands products, categories) / Get Pricesheet by code - 200 (without expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"573"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:34:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a2e71016-be26-435c-a957-cf10b4c792f6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"string","example":"Pricesheet 3A21"},"pricing":{"type":"array","items":{"type":"object","properties":{"category":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]},"id":{"type":"number","example":1779},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":10},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"CP"},"validFrom":{"type":"string","example":"May, 01 2022 00:00:00 +0000"},"validTo":{"type":"string","example":"December, 31 2022 00:00:00 +0000"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"}]}}},"product":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}]},"eanCode":{"type":"string","example":"0753759256211"},"id":{"type":"number","example":40364},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1050 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1050 FietsComputer"}]},"oemCode":{"type":"string","example":"NCABD70005"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":599.95},"pricing":{"type":"object","properties":{"amount":{"type":"number","example":20},"price":{"type":"number","example":4},"quantity":{"type":"number","example":1},"type":{"type":"string","example":"SP"},"validFrom":{"type":"string","example":"May, 01 2022 00:00:00 +0000"},"validTo":{"type":"string","example":"December, 31 2022 00:00:00 +0000"}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}]},"shortName":{"type":"string","example":"Edge 1050 FietsComputer"},"sku":{"type":"string","example":"NCABD70005"},"status":{"type":"string","example":"A"},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70005"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}}}},"example":[{"category":{"descriptions":[{"language":"NL","value":"Fiets"}],"id":1779,"names":[{"language":"NL","value":"Fiets"}],"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"Fiets"}]}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256211","id":40364,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"oemCode":"NCABD70005","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","taxPercentage":0.21,"unit":1}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256289","id":40362,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"oemCode":"NCABD70004","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1}}]},"shopId":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Pricesheet by code - 200 (expands products, categories)":{"value":{"data":{"code":"3A21","description":"","name":"Pricesheet 3A21","pricing":[{"category":{"descriptions":[{"language":"NL","value":"Fiets"}],"id":1779,"names":[{"language":"NL","value":"Fiets"}],"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"Fiets"}]}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256211","id":40364,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1050 FietsComputer"}],"oemCode":"NCABD70005","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1050 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1050 FietsComputer","sku":"NCABD70005","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70005","taxCode":"H","taxPercentage":0.21,"unit":1}},{"product":{"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}],"eanCode":"0753759256289","id":40362,"minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"}],"oemCode":"NCABD70004","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":599.95,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"},"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1}}],"shopId":1},"messages":[],"total":1}},"Get Pricesheet by code - 200 (without expands)":{"value":{"data":{"code":"3A21","description":"","name":"Pricesheet 3A21","pricing":[{"category":{"id":1779,"pricing":{"amount":10,"quantity":1,"type":"CP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}},{"product":{"id":40364,"pricing":{"amount":20,"quantity":1,"type":"SP","validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}},{"product":{"id":40362,"pricing":{"price":4,"quantity":2,"validFrom":"May, 01 2022 00:00:00 +0000","validTo":"December, 31 2022 00:00:00 +0000"}}}],"shopId":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Pricesheet by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:35:16 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7a2f7cfc-bdd1-4be1-8579-92c7e7d0f074"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":12002},"messages":{"type":"array","items":{"type":"string","example":"Pricesheet with id [158] not found"},"example":["Pricesheet with id [158] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/12002"},"status":{"type":"number","example":404},"type":{"type":"string","example":"PricesheetNotFound"}}}}},"examples":{"Get Pricesheet by Id - 404":{"value":{"error":{"code":12002,"messages":["Pricesheet with id [158] not found"],"moreInfo":"https://www.propel.us/docs/errors/12002","status":404,"type":"PricesheetNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Pricesheets

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-pricesheets.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Pricesheets"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/pricesheets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all price sheets.

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Pricesheets - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"152"}},"date":{"schema":{"type":"string","example":"Thu, 31 Mar 2022 17:17:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"77246dc8-4d63-47f5-90c9-1ec5312adefb"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"3A21"},"description":{"type":"string","example":""},"name":{"type":"string","example":"Pricesheet 3A21"},"shopId":{"type":"number","example":1}}},"example":[{"code":"3A21","description":"","name":"Pricesheet 3A21","shopId":1},{"code":"3A22","description":"","name":"Pricesheet 3A22","shopId":1}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Pricesheets - 200":{"value":{"data":[{"code":"3A21","description":"","name":"Pricesheet 3A21","shopId":1},{"code":"3A22","description":"","name":"Pricesheet 3A22","shopId":1}],"messages":[],"total":2}}}}}}}}
>
  
</StatusCodes>

---

## Get Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,surcharges,costprices"}},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"1057"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:30:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"616cce76-17e9-4f12-a31e-6fc6b6815ca1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"costprices":{"type":"array","items":{},"example":[]},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"Schneider"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>blawn</p>\r\n"}}},"example":[{"language":"NL","value":"<p>blawn</p>\r\n"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"sources":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"}}},"example":[{"language":"NL","source":"REST-API","sourceId":"151203"}]},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"surcharges":{"type":"array","items":{},"example":[]},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product by Cluster lookup key and Product Id - 200":{"value":{"data":{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","sources":[{"language":"NL","source":"REST-API","sourceId":"151203"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:30:51 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"4a74b63f-ec87-46ca-8a59-a320886f7457"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707968] not found for the cluster with id [210]"},"example":["Cluster Product with id [707968] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Get Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707968] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve product details by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"expands","in":"query","schema":{"type":"string","example":"translation"},"description":"Optional. Use `translation` when retrieving translated fields in all lanugages. By default, only the default language of the product will be provided. [What is resource expanding?](#expanding-resources)"},{"name":"supplier","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `supplierCode`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2771"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:16:17 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"211845eb-9c56-4683-8ee7-e8af35583625"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":0.21},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product by Id - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","taxPercentage":0.21,"unit":1},"messages":[],"total":1}}}}}},"404":{"description":"Get Product by sourceId - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"172"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 09:18:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"3b73cffc-5153-4eef-ba0d-33867d59d3fa"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with sourceId [40360] not found"},"example":["Product with sourceId [40360] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product by sourceId - 404":{"value":{"error":{"code":80006,"messages":["Product with sourceId [40360] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product Inventory By Warehouse

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-product-inventory-by-warehouse.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product Inventory By Warehouse"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupkey}/{key}/inventory/warehouses/{warehouseId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint gives cumulative product inventory data by searching on a lookup key and warehouse id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"},{"name":"warehouseId","in":"path","required":true,"schema":{"type":"string","example":"4"},"description":"Warehouse id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product Inventory By Warehouse - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"156"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 16:48:09 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5f5e44f4-b507-4b29-98a1-46758e32dc3f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":16},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"productId":{"type":"number","example":38952},"supplierQuantity":{"type":"number","example":3},"supplierReservedQuantity":{"type":"number","example":0},"totalQuantity":{"type":"number","example":19},"totalReservedQuantity":{"type":"number","example":0}}},"example":[{"localQuantity":16,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":3,"supplierReservedQuantity":0,"totalQuantity":19,"totalReservedQuantity":0}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product Inventory By Warehouse - 200":{"value":{"data":[{"localQuantity":16,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":3,"supplierReservedQuantity":0,"totalQuantity":19,"totalReservedQuantity":0}],"messages":[],"total":1}}}}}},"404":{"description":"Get Product Inventory By Warehouse - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 16:49:21 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e2c4820-7217-4d15-a8e2-37d5e57c604c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [59328] not found"},"example":["Product with id [59328] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product Inventory By Warehouse - 404":{"value":{"error":{"code":80006,"messages":["Product with id [59328] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Product Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-product-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Product Inventory"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/products/{lookupkey}/{key}/inventory"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint gives cumulative product inventory data by searching on a lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Product Inventory by Id - 200 / Get Product Inventory by Id - expands - 200 / Get Product Inventory by Id - 200 (reserved stock) / Get Product Inventory by Id - expands - 200 (reserved stock)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"1384"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 14:24:00 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":136},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"productId":{"type":"number","example":38952},"supplierQuantity":{"type":"number","example":54},"supplierReservedQuantity":{"type":"number","example":0},"totalQuantity":{"type":"number","example":190},"totalReservedQuantity":{"type":"number","example":0}}},"example":[{"localQuantity":136,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":54,"supplierReservedQuantity":0,"totalQuantity":190,"totalReservedQuantity":0}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Product Inventory by Id - expands - 200":{"value":{"data":[{"balance":[{"companyId":0,"costPrice":0,"dateModified":"2022-03-09T10:49:54","id":16150,"location":"","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2022-02-21T12:55:27","id":16152,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T10:59:59","id":16157,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-03-09T10:46:25","id":16159,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:05:16","id":16160,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2022-02-16T22:05:17","id":16162,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":38952,"quantity":16,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:12:18","id":16164,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:12:19","id":16165,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:17:44","id":16168,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:17:44","id":16169,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:21:27","id":16172,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-16T22:21:28","id":16173,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:03:24","id":16176,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:03:24","id":16177,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:05:35","id":16180,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:05:35","id":16181,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:18:15","id":16184,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":5,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":0,"dateModified":"2022-02-17T00:18:15","id":16185,"location":"","nextDeliveryDate":"","notes":"","productId":38952,"quantity":13,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":0}],"localQuantity":133,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":38,"supplierReservedQuantity":0,"totalQuantity":171,"totalReservedQuantity":0}],"messages":[],"total":1}},"Get Product Inventory by Id - 200":{"value":{"data":[{"localQuantity":136,"localReservedQuantity":0,"nextDeliveryDate":"2022-02-15T00:00:00","productId":38952,"supplierQuantity":54,"supplierReservedQuantity":0,"totalQuantity":190,"totalReservedQuantity":0}],"messages":[],"total":1}},"Get Product Inventory by Id - 200 (reserved stock)":{"value":{"data":[{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"messages":["Completed"],"total":1}},"Get Product Inventory by Id - expands - 200 (reserved stock)":{"value":{"data":[{"balance":[{"companyId":227583,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16139,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":87,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2023-09-28T19:56:35","id":16140,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":16,"sku":"NCABD70004","supplier":"KERRIDGE","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16141,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":227237,"quantity":77,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:12:48","id":16142,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":82,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0}],"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"messages":["Completed"],"total":1}}}}}},"404":{"description":"Get Product Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Thu, 24 Mar 2022 09:29:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fb39c0b4-ff29-4330-8e2c-09c060175882"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [59328] not found"},"example":["Product with id [59328] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Get Product Inventory by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [59328] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Products by Cluster lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-products-by-cluster-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Products by Cluster lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/clusters/{lookupKey}/{lookupValue}/products"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve cluster products by cluster lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"translation,sources,surcharges,costprices"},"description":"Optional.  Use `translation` to retrieve the cluster products translations. Use `surcharges` to retrive cluster products surcharges etc."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Products by Cluster lookup key - 200 / Get Products by Cluster lookup key - 200 (expands)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2079"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:28:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f377f9ff-0fe0-40f6-b28a-aafa2d513e5b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"costPrice":{"type":"number","example":1.05},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"Schneider"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>blawn</p>\r\n"}}},"example":[{"language":"NL","value":"<p>blawn</p>\r\n"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}}},"example":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"taxPercentage":{"type":"number","example":21},"unit":{"type":"number","example":1}}},"example":[{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","taxCode":"H","taxPercentage":21,"unit":1}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":2}}},"examples":{"Get Products by Cluster lookup key - 200":{"value":{"data":[{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","taxCode":"H","taxPercentage":21,"unit":1}],"messages":[],"total":2}},"Get Products by Cluster lookup key - 200 (expands)":{"value":{"data":[{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044075","id":707966,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"<p>blawn</p>\r\n"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","sources":[{"language":"NL","source":"REST-API","sourceId":"151203"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1},{"costPrice":1.05,"costprices":[],"descriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"eanCode":"4004675044037","id":707967,"manufacturer":"Schneider","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra rood"}],"notes":[{"language":"NL","value":"<p>rood</p>\r\n"}],"oemCode":"151202","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"<p>Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt.</p>\r\n"}],"shortName":"Balpen Slider XB extra rood","sku":"151202","sources":[{"language":"NL","source":"REST-API","sourceId":"151202"}],"status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151202","surcharges":[],"taxCode":"H","taxPercentage":21,"unit":1}],"messages":[],"total":2}}}}}},"404":{"description":"Get Products by Cluster lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"177"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:38:00 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"8b976a47-961b-40a4-98ce-7a1baab013c6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent Cluster with id [211] not found"},"example":["Parent Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentClusterNotFound"}}}}},"examples":{"Get Products by Cluster lookup key - 404":{"value":{"error":{"code":20007,"messages":["Parent Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get resource attribute by resource lookup key and attribute lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-resource-attribute-by-resource-lookup-key-and-attribute-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get resource attribute by resource lookup key and attribute lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes/{attributeLookupKey}/{attributeLookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a specific attribute for a resource identified by resource [lookup key](/reference/legacy/rest-v1/attributes#attribute-lookup-keys) and [attribute lookup key](/reference/legacy/rest-v1/attributes#attribute-lookup-keys). The `attributeClass` Query Param is useful to use when the attribute lookup key is `name` and the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with attribute lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-v1/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"},{"name":"attributeLookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"attributeLookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get product attribute by product id and attribute id - 200 / Get product attribute by product id and attribute name/ class - 200 / Get user attribute by user id and attribute name/ class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"137"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:21:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"556612fa-7597-4b90-b8ac-2e4a90e90604"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":671},"inherited":{"type":"boolean","example":false},"name":{"type":"string","example":"MATERIAAL_FRAME"},"type":{"type":"string","example":"text"},"value":{"example":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}],"anyOf":[{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":false},"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Leather"}}},"example":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},{"type":"string","example":"Y"}]}}},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"total":{"type":"number","example":1}}},"examples":{"Get product attribute by product id and attribute id - 200":{"value":{"data":{"class":"product","id":671,"name":"MATERIAAL_FRAME","type":"text","value":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},"messages":["Completed"],"total":1}},"Get product attribute by product id and attribute name/ class - 200":{"value":{"data":{"class":"product","id":671,"name":"MATERIAAL_FRAME","type":"text","value":[{"inherited":false,"language":"EN","value":"Leather"},{"inherited":false,"language":"NL","value":"Leer"}]},"messages":["Completed"],"total":1}},"Get user attribute by user id and attribute name/ class - 200":{"value":{"data":{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},"messages":["Completed"],"total":1}}}}}},"404":{"description":"Get product attribute by product id and attribute name/ class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"202"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:20:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"3badf180-4f37-4c65-aa7d-80f7a619cf69"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with name [FRAME] and attributeClass [product] not found."},"example":["Attribute with name [FRAME] and attributeClass [product] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Get product attribute by product id and attribute name/ class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [FRAME] and attributeClass [product] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get resource attributes by resource lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-resource-attributes-by-resource-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get resource attributes by resource lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/{resourceType}/{lookupKey}/{lookupValue}/attributes"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves all attributes for a resource identified by its [lookup key](/reference/legacy/rest-v1/attributes#attribute-lookup-keys). Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.  
A resource can be a product, category, user or usergroup.

## Response fields

| **Name** | **Description** |
| --- | --- |
| `id` | Attribute Id |
| `name` | Attribute name |
| `type` | Type of the value of the attribute |
| `class` | Attribute class |
| `value` | Attribute value for the product. Depends on the type. |
| `inherited` | Boolean. Indicates whether the value is directly set on the product or inherited from a parent resource. For `text` and `list` type attributes, `inherited` is part of the localized string for each language. |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","in":"query","schema":{"type":"string","example":"1"},"description":"Page number"},{"name":"offset","in":"query","schema":{"type":"string","example":"50"},"description":"Number of results per page"},{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"resourceType","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Resource type. Possible values are `products`, `categories`, `users`, `usergroups`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use [different lookup](/reference/legacy/rest-v1/attributes#attribute-lookup-keys) keys depending on the resource type"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"37221"},"description":"The value of the key (an id, sourceId, sku, etc.)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get product attributes by product id - 200 (with results) / Get product attributes by product id - 200 (no results) / Get user attributes by user id - 200 / Get usergroup attributes by usergroup id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"4176"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:11:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8ef1f77a-fa1c-402e-a90c-9761af2cbf4b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":11},"inherited":{"type":"boolean","example":true},"name":{"type":"string","example":"PROPELLOR_PLUSPUNT_1"},"type":{"type":"string","example":"text"},"value":{"example":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}],"anyOf":[{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":false},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Pluspunt test NL"}}},"example":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"type":"string","example":"N"},{"type":"number","example":0},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"string","example":""},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"type":"array","items":{"type":"object","properties":{"inherited":{"type":"boolean","example":true},"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}}},"example":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"array","items":{},"example":[]},{"type":"number","example":0},{"type":"number","example":0}]}}},"example":[{"class":"product","id":11,"name":"PROPELLOR_PLUSPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"class":"product","id":12,"name":"PROPELLOR_PLUSPUNT_2","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel is compact in te klappen zodat je hem gemakkelijk meeneemt."}]},{"class":"product","id":13,"name":"PROPELLOR_PLUSPUNT_3","type":"text","value":[]},{"class":"product","id":15,"name":"PROPELLOR_PLUSPUNT_4","type":"text","value":[]},{"class":"product","id":16,"name":"PROPELLOR_PLUSPUNT_5","type":"text","value":[]},{"class":"product","id":17,"name":"PROPELLOR_PLUSPUNT_6","type":"text","value":[]},{"class":"product","id":18,"name":"PROPELLOR_PLUSPUNT_7","type":"text","value":[]},{"class":"product","id":19,"name":"PROPELLOR_PLUSPUNT_8","type":"text","value":[]},{"class":"product","id":20,"name":"PROPELLOR_MINPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel heeft geen verstelbare rugleuning."}]},{"class":"product","id":21,"name":"PROPELLOR_MINPUNT_2","type":"text","value":[]},{"class":"product","id":22,"name":"PROPELLOR_MINPUNT_3","type":"text","value":[]},{"class":"product","id":23,"name":"PROPELLOR_MINPUNT_4","type":"text","value":[]},{"class":"product","id":24,"name":"PROPELLOR_MINPUNT_5","type":"text","value":[]},{"class":"product","id":25,"name":"PROPELLOR_MINPUNT_6","type":"text","value":[]},{"class":"product","id":26,"name":"PROPELLOR_MINPUNT_7","type":"text","value":[]},{"class":"product","id":27,"name":"PROPELLOR_MINPUNT_8","type":"text","value":[]},{"class":"product","id":28,"name":"PROPELLOR_LABEL_1","type":"text","value":[]},{"class":"product","id":29,"name":"PROPELLOR_LABEL_2","type":"text","value":[]},{"class":"product","id":45,"name":"META_DESCRIPTION_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Buy your {product_name} at {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"FR","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"NL","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."}]},{"class":"product","id":46,"name":"META_TITLE_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Shop your {product_name , 40} | {shop_name}"},{"inherited":true,"language":"FR","value":"Koop uw {product_name , 40} | {shop_name}"},{"inherited":true,"language":"NL","value":"Koop uw {product_name , 40} | {shop_name}"}]},{"class":"product","id":66,"inherited":true,"name":"PROPELLOR_SALE","type":"enum","value":"N"},{"class":"product","id":67,"inherited":true,"name":"VALUEPOINTS_WAARDE","type":"decimal","value":0},{"class":"product","id":68,"name":"MATERIAAL_BINNENTENT","type":"text","value":[]},{"class":"product","id":73,"name":"BESTAND_TEGEN","type":"text","value":[]},{"class":"product","id":75,"name":"CAPACITEIT","type":"text","value":[]},{"class":"product","id":77,"name":"BREEDTE","type":"text","value":[]},{"class":"product","id":78,"name":"GEWICHT","type":"text","value":[]},{"class":"product","id":82,"name":"DIEPTE","type":"text","value":[]},{"class":"product","id":95,"name":"HOOGTE","type":"text","value":[]},{"class":"product","id":121,"inherited":true,"name":"SONAR_WATERPROOF","type":"enum","value":""},{"class":"product","id":139,"name":"SHOP_IN_KLEUR","type":"text","value":[]},{"class":"product","id":140,"name":"SHOP_IN_SERIE","type":"text","value":[]},{"class":"product","id":164,"name":"PROPELLOR_KLEUR","type":"text","value":[]},{"class":"product","id":165,"name":"PROPELLOR_MAAT","type":"text","value":[]},{"class":"product","id":167,"name":"DELIVERY_PROMISE_A","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":168,"name":"DELIVERY_PROMISE_B","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":169,"name":"DELIVERY_PROMISE_C","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"class":"product","id":170,"name":"DELIVERY_PROMISE_D","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"class":"product","id":171,"name":"DELIVERY_PROMISE_E","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"class":"product","id":172,"name":"DELIVERY_PROMISE_F","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"class":"product","id":173,"name":"DELIVERY_PROMISE_G","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"class":"product","id":174,"name":"DELIVERY_PROMISE_H","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"class":"product","id":175,"name":"DELIVERY_PROMISE_I","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"class":"product","id":176,"name":"DELIVERY_PROMISE_J","type":"text","value":[]},{"class":"product","id":177,"name":"DELIVERY_PROMISE_K","type":"text","value":[]},{"class":"product","id":179,"name":"PROPELLOR_PRODUCT_FORMULA","type":"text","value":[]},{"class":"product","id":193,"name":"PROPELLOR_PACKAGE","type":"text","value":[]},{"class":"product","id":641,"inherited":true,"name":"NUMERIC_DEMO","type":"integer","value":0},{"class":"product","id":642,"inherited":true,"name":"DECIMAL_DEMO","type":"decimal","value":0},{"class":"product","id":643,"name":"DATETIME_DEMO","type":"datetime"}]},"end":{"type":"number","example":50},"itemsFound":{"type":"number","example":108},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":50},"page":{"type":"number","example":1},"pages":{"type":"number","example":3},"start":{"type":"number","example":1},"total":{"type":"number","example":50}}},"examples":{"Get product attributes by product id - 200 (no results)":{"value":{"data":[],"itemsFound":108,"messages":["Completed"],"offset":50,"page":5,"pages":3,"total":1}},"Get product attributes by product id - 200 (with results)":{"value":{"data":[{"class":"product","id":11,"name":"PROPELLOR_PLUSPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"Pluspunt test NL"}]},{"class":"product","id":12,"name":"PROPELLOR_PLUSPUNT_2","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel is compact in te klappen zodat je hem gemakkelijk meeneemt."}]},{"class":"product","id":13,"name":"PROPELLOR_PLUSPUNT_3","type":"text","value":[]},{"class":"product","id":15,"name":"PROPELLOR_PLUSPUNT_4","type":"text","value":[]},{"class":"product","id":16,"name":"PROPELLOR_PLUSPUNT_5","type":"text","value":[]},{"class":"product","id":17,"name":"PROPELLOR_PLUSPUNT_6","type":"text","value":[]},{"class":"product","id":18,"name":"PROPELLOR_PLUSPUNT_7","type":"text","value":[]},{"class":"product","id":19,"name":"PROPELLOR_PLUSPUNT_8","type":"text","value":[]},{"class":"product","id":20,"name":"PROPELLOR_MINPUNT_1","type":"text","value":[{"inherited":false,"language":"NL","value":"De stoel heeft geen verstelbare rugleuning."}]},{"class":"product","id":21,"name":"PROPELLOR_MINPUNT_2","type":"text","value":[]},{"class":"product","id":22,"name":"PROPELLOR_MINPUNT_3","type":"text","value":[]},{"class":"product","id":23,"name":"PROPELLOR_MINPUNT_4","type":"text","value":[]},{"class":"product","id":24,"name":"PROPELLOR_MINPUNT_5","type":"text","value":[]},{"class":"product","id":25,"name":"PROPELLOR_MINPUNT_6","type":"text","value":[]},{"class":"product","id":26,"name":"PROPELLOR_MINPUNT_7","type":"text","value":[]},{"class":"product","id":27,"name":"PROPELLOR_MINPUNT_8","type":"text","value":[]},{"class":"product","id":28,"name":"PROPELLOR_LABEL_1","type":"text","value":[]},{"class":"product","id":29,"name":"PROPELLOR_LABEL_2","type":"text","value":[]},{"class":"product","id":45,"name":"META_DESCRIPTION_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Buy your {product_name} at {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"FR","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."},{"inherited":true,"language":"NL","value":"Bestel de {product_name} bij {shop_name}. {product_description_plain , 60}."}]},{"class":"product","id":46,"name":"META_TITLE_MASK","type":"text","value":[{"inherited":true,"language":"EN","value":"Shop your {product_name , 40} | {shop_name}"},{"inherited":true,"language":"FR","value":"Koop uw {product_name , 40} | {shop_name}"},{"inherited":true,"language":"NL","value":"Koop uw {product_name , 40} | {shop_name}"}]},{"class":"product","id":66,"inherited":true,"name":"PROPELLOR_SALE","type":"enum","value":"N"},{"class":"product","id":67,"inherited":true,"name":"VALUEPOINTS_WAARDE","type":"decimal","value":0},{"class":"product","id":68,"name":"MATERIAAL_BINNENTENT","type":"text","value":[]},{"class":"product","id":73,"name":"BESTAND_TEGEN","type":"text","value":[]},{"class":"product","id":75,"name":"CAPACITEIT","type":"text","value":[]},{"class":"product","id":77,"name":"BREEDTE","type":"text","value":[]},{"class":"product","id":78,"name":"GEWICHT","type":"text","value":[]},{"class":"product","id":82,"name":"DIEPTE","type":"text","value":[]},{"class":"product","id":95,"name":"HOOGTE","type":"text","value":[]},{"class":"product","id":121,"inherited":true,"name":"SONAR_WATERPROOF","type":"enum","value":""},{"class":"product","id":139,"name":"SHOP_IN_KLEUR","type":"text","value":[]},{"class":"product","id":140,"name":"SHOP_IN_SERIE","type":"text","value":[]},{"class":"product","id":164,"name":"PROPELLOR_KLEUR","type":"text","value":[]},{"class":"product","id":165,"name":"PROPELLOR_MAAT","type":"text","value":[]},{"class":"product","id":167,"name":"DELIVERY_PROMISE_A","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag voor [[deadline]] uur besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":168,"name":"DELIVERY_PROMISE_B","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Vandaag besteld, [[day_of_week]] in huis</span>"}]},{"class":"product","id":169,"name":"DELIVERY_PROMISE_C","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[days]] dagen</span>"}]},{"class":"product","id":170,"name":"DELIVERY_PROMISE_D","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Verwachte levering binnen [[weeks]] weken</span>"}]},{"class":"product","id":171,"name":"DELIVERY_PROMISE_E","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #ff6600\">Let op, lange levertijd</span>"}]},{"class":"product","id":172,"name":"DELIVERY_PROMISE_F","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet leverbaar</span>"}]},{"class":"product","id":173,"name":"DELIVERY_PROMISE_G","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is tijdelijk niet leverbaar</span>"}]},{"class":"product","id":174,"name":"DELIVERY_PROMISE_H","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #008c23\">Dit product wordt geleverd op [[release_date]]</span>"}]},{"class":"product","id":175,"name":"DELIVERY_PROMISE_I","type":"text","value":[{"inherited":true,"language":"NL","value":"<span style=\"color: #dc3545\">Dit product is niet meer leverbaar</span>"}]},{"class":"product","id":176,"name":"DELIVERY_PROMISE_J","type":"text","value":[]},{"class":"product","id":177,"name":"DELIVERY_PROMISE_K","type":"text","value":[]},{"class":"product","id":179,"name":"PROPELLOR_PRODUCT_FORMULA","type":"text","value":[]},{"class":"product","id":193,"name":"PROPELLOR_PACKAGE","type":"text","value":[]},{"class":"product","id":641,"inherited":true,"name":"NUMERIC_DEMO","type":"integer","value":0},{"class":"product","id":642,"inherited":true,"name":"DECIMAL_DEMO","type":"decimal","value":0},{"class":"product","id":643,"name":"DATETIME_DEMO","type":"datetime"}],"end":50,"itemsFound":108,"messages":["Completed"],"offset":50,"page":1,"pages":3,"start":1,"total":50}},"Get user attributes by user id - 200":{"value":{"data":[{"class":"user","id":47,"inherited":true,"name":"REKENING","type":"decimal","value":1.6},{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},{"class":"user","id":49,"inherited":true,"name":"CONTANT","type":"decimal","value":0},{"class":"user","id":50,"inherited":true,"name":"SHOW_CONTANT","type":"enum","value":"Y"},{"class":"user","id":54,"inherited":true,"name":"MULTISAFEPAY_IDEAL","type":"decimal","value":0},{"class":"user","id":63,"inherited":true,"name":"SHOW_MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":64,"inherited":true,"name":"MULTISAFEPAY_MASTERCARD","type":"decimal","value":0},{"class":"user","id":65,"inherited":true,"name":"SHOW_MULTISAFEPAY_MASTERCARD","type":"enum","value":"N"},{"class":"user","id":125,"inherited":true,"name":"MULTISAFEPAY_VISA","type":"decimal","value":99999.99999},{"class":"user","id":126,"inherited":true,"name":"SHOW_MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":127,"inherited":true,"name":"MULTISAFEPAY_AMERICAN EXPRESS","type":"decimal","value":99999.99999},{"class":"user","id":128,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":129,"inherited":true,"name":"PAYPAL","type":"decimal","value":99999.99999},{"class":"user","id":130,"inherited":true,"name":"SHOW_PAYPAL","type":"enum","value":"Y"},{"class":"user","id":131,"inherited":true,"name":"MULTISAFEPAY_PAYAFTER","type":"decimal","value":99999.99999},{"class":"user","id":132,"inherited":true,"name":"SHOW_MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":133,"inherited":true,"name":"INCASSO","type":"decimal","value":99999.99999},{"class":"user","id":134,"inherited":true,"name":"SHOW_INCASSO","type":"enum","value":"Y"},{"class":"user","id":629,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRECTBANK","type":"enum","value":"Y"},{"class":"user","id":630,"inherited":true,"name":"SHOW_MULTISAFEPAY_MISTERCASH","type":"enum","value":"Y"},{"class":"user","id":631,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRDEB","type":"enum","value":"Y"},{"class":"user","id":632,"inherited":true,"name":"SHOW_MULTISAFEPAY_GIROPAY","type":"enum","value":"Y"},{"class":"user","id":633,"inherited":true,"name":"SHOW_MULTISAFEPAY_BANKTRANS","type":"enum","value":"Y"},{"class":"user","id":634,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMEX","type":"enum","value":"Y"},{"class":"user","id":635,"inherited":true,"name":"SHOW_MULTISAFEPAY_SOFORT","type":"enum","value":"Y"},{"class":"user","id":636,"inherited":true,"name":"SHOW_MULTISAFEPAY_MAESTRO","type":"enum","value":"Y"},{"class":"user","id":141,"inherited":true,"name":"mobileapp.REKENING","type":"enum","value":"N"},{"class":"user","id":142,"inherited":true,"name":"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":143,"inherited":true,"name":"mobileapp.MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":144,"inherited":true,"name":"mobileapp.MULTISAFEPAY_MASTERCARD","type":"enum","value":"Y"},{"class":"user","id":145,"inherited":true,"name":"mobileapp.MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":146,"inherited":true,"name":"mobileapp.MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":153,"inherited":true,"name":"CREDIT_LIMIT","type":"decimal","value":0},{"class":"user","id":154,"inherited":true,"name":"CREDIT_LIMIT_INTERVAL","type":"enum","value":"month"},{"class":"user","id":155,"inherited":true,"name":"FI_DEFAULT_BUDGET_GROUP","type":"enum","value":"8010"},{"class":"user","id":178,"name":"PROPELLOR_USER_FORMULA","type":"text","value":[]},{"class":"user","id":182,"inherited":true,"name":"EDIT_DELIVERY_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":183,"inherited":true,"name":"EDIT_INVOICE_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":184,"inherited":true,"name":"EC.viewUsergroupOrders","type":"enum","value":"N"},{"class":"user","id":626,"inherited":true,"name":"PAY_WITH_CREDITPOINTS","type":"enum","value":"N"}],"end":40,"itemsFound":40,"messages":["Completed"],"offset":50,"page":1,"pages":1,"start":1,"total":40}},"Get usergroup attributes by usergroup id - 200":{"value":{"data":[{"class":"user","id":47,"inherited":true,"name":"REKENING","type":"decimal","value":1.6},{"class":"user","id":48,"inherited":false,"name":"SHOW_REKENING","type":"enum","value":"Y"},{"class":"user","id":49,"inherited":true,"name":"CONTANT","type":"decimal","value":0},{"class":"user","id":50,"inherited":true,"name":"SHOW_CONTANT","type":"enum","value":"Y"},{"class":"user","id":54,"inherited":true,"name":"MULTISAFEPAY_IDEAL","type":"decimal","value":0},{"class":"user","id":63,"inherited":true,"name":"SHOW_MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":64,"inherited":true,"name":"MULTISAFEPAY_MASTERCARD","type":"decimal","value":0},{"class":"user","id":65,"inherited":true,"name":"SHOW_MULTISAFEPAY_MASTERCARD","type":"enum","value":"N"},{"class":"user","id":125,"inherited":true,"name":"MULTISAFEPAY_VISA","type":"decimal","value":99999.99999},{"class":"user","id":126,"inherited":true,"name":"SHOW_MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":127,"inherited":true,"name":"MULTISAFEPAY_AMERICAN EXPRESS","type":"decimal","value":99999.99999},{"class":"user","id":128,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":129,"inherited":true,"name":"PAYPAL","type":"decimal","value":99999.99999},{"class":"user","id":130,"inherited":true,"name":"SHOW_PAYPAL","type":"enum","value":"Y"},{"class":"user","id":131,"inherited":true,"name":"MULTISAFEPAY_PAYAFTER","type":"decimal","value":99999.99999},{"class":"user","id":132,"inherited":true,"name":"SHOW_MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":133,"inherited":true,"name":"INCASSO","type":"decimal","value":99999.99999},{"class":"user","id":134,"inherited":true,"name":"SHOW_INCASSO","type":"enum","value":"Y"},{"class":"user","id":629,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRECTBANK","type":"enum","value":"Y"},{"class":"user","id":630,"inherited":true,"name":"SHOW_MULTISAFEPAY_MISTERCASH","type":"enum","value":"Y"},{"class":"user","id":631,"inherited":true,"name":"SHOW_MULTISAFEPAY_DIRDEB","type":"enum","value":"Y"},{"class":"user","id":632,"inherited":true,"name":"SHOW_MULTISAFEPAY_GIROPAY","type":"enum","value":"Y"},{"class":"user","id":633,"inherited":true,"name":"SHOW_MULTISAFEPAY_BANKTRANS","type":"enum","value":"Y"},{"class":"user","id":634,"inherited":true,"name":"SHOW_MULTISAFEPAY_AMEX","type":"enum","value":"Y"},{"class":"user","id":635,"inherited":true,"name":"SHOW_MULTISAFEPAY_SOFORT","type":"enum","value":"Y"},{"class":"user","id":636,"inherited":true,"name":"SHOW_MULTISAFEPAY_MAESTRO","type":"enum","value":"Y"},{"class":"user","id":141,"inherited":true,"name":"mobileapp.REKENING","type":"enum","value":"N"},{"class":"user","id":142,"inherited":true,"name":"mobileapp.MULTISAFEPAY_AMERICAN EXPRESS","type":"enum","value":"Y"},{"class":"user","id":143,"inherited":true,"name":"mobileapp.MULTISAFEPAY_IDEAL","type":"enum","value":"Y"},{"class":"user","id":144,"inherited":true,"name":"mobileapp.MULTISAFEPAY_MASTERCARD","type":"enum","value":"Y"},{"class":"user","id":145,"inherited":true,"name":"mobileapp.MULTISAFEPAY_PAYAFTER","type":"enum","value":"Y"},{"class":"user","id":146,"inherited":true,"name":"mobileapp.MULTISAFEPAY_VISA","type":"enum","value":"Y"},{"class":"user","id":153,"inherited":true,"name":"CREDIT_LIMIT","type":"decimal","value":0},{"class":"user","id":154,"inherited":true,"name":"CREDIT_LIMIT_INTERVAL","type":"enum","value":"month"},{"class":"user","id":155,"inherited":true,"name":"FI_DEFAULT_BUDGET_GROUP","type":"enum","value":"8010"},{"class":"user","id":178,"name":"PROPELLOR_USER_FORMULA","type":"text","value":[]},{"class":"user","id":182,"inherited":true,"name":"EDIT_DELIVERY_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":183,"inherited":true,"name":"EDIT_INVOICE_ADDRESS","type":"enum","value":"Y"},{"class":"user","id":184,"inherited":true,"name":"EC.viewUsergroupOrders","type":"enum","value":"N"},{"class":"user","id":626,"inherited":true,"name":"PAY_WITH_CREDITPOINTS","type":"enum","value":"N"}],"end":40,"itemsFound":40,"messages":["Completed"],"offset":50,"page":1,"pages":1,"start":1,"total":40}}}}}},"400":{"description":"Get product attributes by product id - 400 (invalid page or offset)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 11:51:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d5416483-9bbf-41e9-a16c-5661f7b24719"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10015},"messages":{"type":"array","items":{"type":"string","example":"Offset cannot be more than 100"},"example":["Offset cannot be more than 100"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10015"},"status":{"type":"number","example":400},"type":{"type":"string","example":"PaginatedResponseException"}}}}},"examples":{"Get product attributes by product id - 400 (invalid page or offset)":{"value":{"error":{"code":10015,"messages":["Offset cannot be more than 100"],"moreInfo":"https://www.propel.us/docs/errors/10015","status":400,"type":"PaginatedResponseException"}}}}}}},"404":{"description":"Get product attributes by product id - 404 / Get user attributes by user id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Mon, 14 Mar 2022 12:09:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"43c4015f-9ea5-4ff9-b2c2-a243179db9d2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10009},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Product] with id [372212] not found."},"example":["Parent resource [Product] with id [372212] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10009"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentProductNotFound"}}}}},"examples":{"Get product attributes by product id - 404":{"value":{"error":{"code":10009,"messages":["Parent resource [Product] with id [372212] not found."],"moreInfo":"https://www.propel.us/docs/errors/10009","status":404,"type":"ParentProductNotFound"}}},"Get user attributes by user id - 404":{"value":{"error":{"code":90008,"messages":["Parent resource [User] with id [14123] not found."],"moreInfo":"https://www.propel.us/docs/errors/90008","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Shipments

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-shipments.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Shipments"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/shipments"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all order shipments.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""},"404":{"description":"Get Shipments - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"155"}},"date":{"schema":{"type":"string","example":"Thu, 28 Apr 2022 17:38:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e8d06185-f61c-414e-a2a0-5b7fda9e6974"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [295] not found"},"example":["Order with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Get Shipments - 404":{"value":{"error":{"code":15001,"messages":["Order with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get User Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-user-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a user address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"462"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:54:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get User Address by Id - 404 (address not found) / Get User Address by Id - 404 (user not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 20:55:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ec3d49c0-0e66-43d0-b954-753d8bf0fb70"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":90006},"messages":{"type":"array","items":{"type":"string","example":"Address with id [819081] not found for [User] with id [14760]"},"example":["Address with id [819081] not found for [User] with id [14760]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/90006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AddressNotFound"}}}}},"examples":{"Get User Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819081] not found for [User] with id [14760]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get User Address by Id - 404 (user not found)":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get User Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-user-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all user addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User Delivery Addresses by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"464"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7ba7b832-624b-49ee-ba0d-993be90732a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81908},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User Delivery Addresses by Id - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81908,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}],"messages":[],"total":1}}}}}},"404":{"description":"Get User Delivery Addresses by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ac58aef4-a7f5-426b-a374-170218dffed2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Get User Delivery Addresses by Id - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve user details by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources,parent"},"description":"Use `expands` as a query parameter to fetch additional information for users like sources, parent, etc.\n\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array.\n`parent`: use this value in the `expands` query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a user can be a resource of type `usergroup`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get User by  id - 200 / Get User by lookup key - 200 (expands: sources, parent)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"707"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:27:33 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"fullName":{"type":"string","example":"Miles McCoy"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14760},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":"Whitepaper Download"},"defaultobjectId":{"type":"number","example":221701},"department":{"type":"string","example":""},"id":{"type":"number","example":119},"inheritOrderList":{"type":"string","example":"Y"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Whitepaper Download"},"notes":{"type":"string","example":""},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"userManagerId":{"type":"string","example":""}}},"phone":{"type":"string","example":"0032445888"},"sources":{"type":"array","items":{},"example":[]},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."},"vatNumber":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get User by  id - 200":{"value":{"data":{"abbreviation":"MM","company":"","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","firstName":"Miles","fullName":"Miles McCoy","gender":"M","id":14760,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","ssn":"","title":"Mr.","vatNumber":""},"messages":[],"total":1}},"Get User by lookup key - 200 (expands: sources, parent)":{"value":{"data":{"abbreviation":"KP","company":"Propellor","dateOfBirth":"July, 22 1986 00:00:00 +0000","debtorId":"000002","email":"info@propellor.eu","firstName":"Karl","fullName":"Karl Pflieger","gender":"M","id":14550,"lastName":"Pflieger","login":"k.pflieger","middleName":"","mobile":"06123456789","parent":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Whitepaper Download","defaultobjectId":221701,"department":"","id":119,"inheritOrderList":"Y","inheritProductList":"Y","name":"Whitepaper Download","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"userManagerId":""},"phone":"","sources":[],"ssn":"","title":"Mr","vatNumber":""},"messages":[],"total":1}}}}}},"400":{"description":"Get User by ld - 400 (invalid lookupkey)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:27:46 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e32401da-1c99-40c7-a60a-039ff9b0246f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get User by ld - 400 (invalid lookupkey)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Wed, 16 Mar 2022 17:26:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"4ac42aa6-87c5-41e1-9034-d1b09fe5a0da"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with id [146221] not found"},"example":["User with id [146221] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Get User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with id [146221] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup Address by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-usergroup-address-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup Address by Id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve details for a usergroup address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"462"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:54:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"14bcc898-8faa-46c0-bfae-56ebd5c4464c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup Address by Id - 200":{"value":{"data":{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"},"messages":[],"total":1}}}}}},"404":{"description":"Get Usergroup Address by Id - 404 (address not found) / Get Usergroup Address by Id - 404 (usergroup not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 20:56:59 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1e3114dc-c91a-4d93-8750-fafdee3ea687"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":90006},"messages":{"type":"array","items":{"type":"string","example":"Address with id [819181] not found for [Usergroup] with id [122]"},"example":["Address with id [819181] not found for [Usergroup] with id [122]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/90006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AddressNotFound"}}}}},"examples":{"Get Usergroup Address by Id - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819181] not found for [Usergroup] with id [122]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Get Usergroup Address by Id - 404 (usergroup not found)":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup Addresses by type

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-usergroup-addresses-by-type.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup Addresses by type"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve a list of all usergroup addresses. Addresses can be filtered by type.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"type","in":"query","schema":{"type":"string","example":"delivery"},"description":"Optional. Only retrieve a certain type of address. Possible values:\n\ndelivery\ninvoice\nhome"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup Delivery Addresses by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"464"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7ba7b832-624b-49ee-ba0d-993be90732a3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Arnhem"},"code":{"type":"string","example":"11234"},"company":{"type":"string","example":"Propel"},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81918},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"name":{"type":"string","example":""},"notes":{"type":"string","example":"Address notes"},"number":{"type":"string","example":"34"},"numberExtension":{"type":"string","example":"A"},"phone":{"type":"string","example":"0032445888"},"postalCode":{"type":"string","example":"6822 DE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Noordpad"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":"www.propel.us"}}},"example":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup Delivery Addresses by Id - 200":{"value":{"data":[{"active":"Y","city":"Arnhem","code":"11234","company":"Propel","country":"NL","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"U","icp":"N","id":81918,"isDefault":"N","lastName":"McCoy","middleName":"","mobile":"0038975648","name":"","notes":"Address notes","number":"34","numberExtension":"A","phone":"0032445888","postalCode":"6822 DE","region":"","street":"Noordpad","type":"delivery","url":"www.propel.us"}],"messages":[],"total":1}}}}}},"404":{"description":"Get Usergroup Delivery Addresses by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 18:50:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ac58aef4-a7f5-426b-a374-170218dffed2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Get Usergroup Delivery Addresses by Id - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Get Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/get-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to retrieve usergroup details by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for usergroups like sources, etc.\n\n`sources`: if the `expands` parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Usergroup by Id - 200 / Get Usergroup by lookup key - 200 (expands: sources)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"348"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:29:14 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":""},"defaultobjectId":{"example":"","anyOf":[{"type":"string","example":""},{"type":"number","example":221701}]},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"sources":{"type":"array","items":{},"example":[]},"userManagerId":{"type":"string","example":""}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Usergroup by Id - 200":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","defaultobjectId":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},"messages":[],"total":1}},"Get Usergroup by lookup key - 200 (expands: sources)":{"value":{"data":{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Whitepaper Download","defaultobjectId":221701,"department":"","id":119,"inheritOrderList":"Y","inheritProductList":"Y","name":"Whitepaper Download","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","sources":[],"userManagerId":""},"messages":[],"total":1}}}}}},"400":{"description":"Get Usergroup by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:21:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5fa94d0-251c-4653-ae69-8869c77db00f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Usergroup by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Usergroup by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:20:53 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"50d45de3-d8b4-4c73-a2c7-6c5208255c1f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21315] not found"},"example":["Usergroup with id [21315] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Get Usergroup by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21315] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Images

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/images.tag

<LegacyBanner />



The image API allows you to upload multiple product images in a single API call along with additional metadata for each image.

> The image API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## REST v1 Reference

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1

# REST v1 Reference

<LegacyBanner />

Complete endpoint reference for the Propeller REST v1 API. Browse endpoints by resource using the sidebar. This reference is maintained for partners with existing v1 implementations. New projects should use the [REST v2 API](/reference/rest).

---

## Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/inventory.tag

<LegacyBanner />



Inventory API gives you access to your warehouses and warehouse locations, so you can adjust inventory quantities and review inventory changes for products in your catalog. Inventory API allows you to update the local and supplier inventory of each product.

Can work with multiple warehouses, but also organize your warehouse and divide it to as many locations as you want to easily find the products.

Inventory allows you to track stock quantities per SKU and optionally per supplier and supplier product code. That's why there are two types of inventory: local and supplier.

Inventory can also be customer specific, i.e. reserved for a given company and/ or usergroup.

## Inventory item fields

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **id** (integer) | Propeller inventory record unique id. | yes |
| **productId** (integer) | Propeller product unique id. | yes |
| **quantity** (integer) | Available stock quantity. | yes |
| **costPrice** (integer) | Product cost price. | no  <br />Default value is 0.00 |
| **supplier** (string) | Supplier name. For local stock this value is always INTERN and for supplier stock by default this is the product supplier value, but also can create stock for a different suppliers | yes |
| **supplierCode** (string) | Suppliers' unique identifier for the product | `yes` |
| **sku** (string) | Product unique code | yes |
| **dateModified** (date) | Date and time when the stock record is modified. | yes |
| **warehouseId** (integer) | Warehouse unique id. If warehouseId is not specified, it's set to 0 by default. | yes |
| `companyId` (integer) | Company specific (reserved) inventory. Quantity reserved for a given company | no  <br />Defaults to `0` |
| `usergroupId` (integer) | Usergroup specific (reserved) inventory. Quantity reserved for a given usergroup. Will be deprecated in cloud | no  <br />Defaults to `0` |
| **location** (string) | Racks and shelves in the warehouse can be named and keep track of product stock location name. | no |
| **nextDeliveryDate** (date) | Expected date to receive new product stock | `no` |
| **notes** (string) | Inventory record notes. | no |

## Identifiers

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **id** (integer) | Propeller inventory record unique id. | yes |

## Expands

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| **inventoryBalance** | With inventoryBalance expanded, detailed view of all inventory records is returned for every product. | no |

## Inventory Errors

This section describes error codes specific for the `Inventory` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `13004` | InventoryExists | 400 | Inventory already exists | Inventory already exists |
| `13005` | InventoryMultipleFound | 400 | Multiple inventories found. Please provide additional filters | Multiple inventory records with such search criteria exist |
| `13006` | InventoryNotFound | 404 | Inventory does not exist | Inventory with such lookup key not found |
| `13007` | InvalidInventoryType | 400 | Invalid inventory type | Not a valid inventory type |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Links

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/links.tag

<LegacyBanner />



Propeller supports different types of resources, such as categories, products, usergroups, users, companies, etc. These resources can be linked to one another to cover different use cases, from enriching products with other similar products, accessories, etc. to indicating an account manager user of a company. These relationship types are predefined and are listed below. The Link API can be used to consult, create, update or delete a link between two resources.

## Link types

| **Type** | **Subtype** | **From resource** | **To resource** | **Use case** |
| --- | --- | --- | --- | --- |
| `accessories` | \* | \* | \* | Typically used for products enrichment |
| `accessoryfor` | \* | \* | \* | Typically used for products enrichment |
| `related` | \* | \* | \* | Typically used for products enrichment |
| `relatedfor` | \* | \* | \* | Typically used for products enrichment |
| `alternatives` | \* | \* | \* | Typically used for products enrichment |
| `options` | \* | \* | \* | Typically used for products enrichment |
| `parts` | \* | \* | \* | Typically used for products enrichment |
| `partfor` | \* | \* | \* | Typically used for products enrichment |
| `account` | manage | user | company | User which is an account manager of a company |
| `account` | manage | contact | company | Contact which is an account manager of a company |

\*any can be used

## Link Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller link id, auto-generated |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `type` | Link type | string |
| `subtype` | Link subtype | string |
| `isDefault` | Indicates whether the `to` resource is the default one of the particular type/ subtype for the `from` resource | boolean |
| `isActive` | Indicates whether the link is active, same as non existing if not | boolean |
| `from` | The resource for which relationships are created | [LinkResource](#link-resource) |
| `to` | The resource to which relationships are created | [LinkResource](#link-resource) |
| `priority` | The order/ priority of the link in relation to other links of the same type, subtype, from and to resource | int |

## Link Resource

A link resource is a JSON object used for identifying resources that need to be linked. It has two properties: to indicate the class of the resource (product, user, category, etc.) and it's id.

```json
{
    "class": "product",
    "id": 56987
}
```
## Link Errors

This section describes error codes specific for the `Link` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `18001` | LinkInvalidClass | 400 | No links defined for class | The link type/ subtype combination is not valid for the from/ to class |
| `18002` | LinkInvalidType | 400 | Invalid link type/ subtype | Invalid link type or subtype. No such link predefined |
| `18003` | LinkNotFound | 404 | Link not found | Link does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/order-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve order details by a specific lookupKey / lookupId combination

| **lookupKeys** |
| --- |
| `id` |
| `sourceId` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"orderitems"},"description":"Optional.  Use `orderitems` to retrieve the orderitems of the order. Use `orderitems.product` to retrive product details for each orderitem."},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1600"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get Order by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2295"}},"date":{"schema":{"type":"string","example":"Thu, 24 Mar 2022 12:17:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9833f0d7-ea4c-475e-9121-b0558c4083f7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{}},"date":{"type":"string","example":"2022-03-16T15:00:55"},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"id":{"type":"number","example":195},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"julien@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"items":{"type":"array","items":{"type":"object","properties":{"childItems":{"type":"array","items":{},"example":[]},"discountAmount":{"type":"number","example":0},"discountAmountNet":{"type":"number","example":0},"discountAmountTotal":{"type":"number","example":0},"discountAmountTotalNet":{"type":"number","example":0},"discountPercentage":{"type":"number","example":0},"name":{"type":"string","example":"Gallagher MBS400 fence energiser (230V/12V/Solar)"},"notes":{"type":"string","example":""},"price":{"type":"number","example":292.94},"quantity":{"type":"number","example":1},"sku":{"type":"string","example":"390307"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"390307"},"taxCode":{"type":"string","example":"L"},"taxPercentage":{"type":"number","example":11},"type":{"type":"string","example":"product"},"unit":{"type":"number","example":1}}},"example":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","price":292.94,"quantity":1,"sku":"390307","supplier":"INTERN","supplierCode":"390307","taxCode":"L","taxPercentage":11,"type":"product","unit":1}]},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"pickUpLocationId":{"type":"number","example":0},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81903},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"20"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shop":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","example":"Propellor Sonar"}}},"shopId":{"type":"number","example":1},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"11":{"type":"number","example":32.2234},"21":{"type":"number","example":0}}},"totalGross":{"type":"number","example":292.94},"totalNet":{"type":"number","example":325.1634}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14718}}},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":1}}},"examples":{"Get Order by Id - 200":{"value":{"data":{"channelId":1,"clientData":{},"date":"2022-03-16T15:00:55","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":195,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"julien@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"items":[{"childItems":[],"discountAmount":0,"discountAmountNet":0,"discountAmountTotal":0,"discountAmountTotalNet":0,"discountPercentage":0,"name":"Gallagher MBS400 fence energiser (230V/12V/Solar)","notes":"","price":292.94,"quantity":1,"sku":"390307","supplier":"INTERN","supplierCode":"390307","taxCode":"L","taxPercentage":11,"type":"product","unit":1}],"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","pickUpLocationId":0,"postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shop":{"id":1,"name":"Propellor Sonar"},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"11":32.2234,"21":0},"totalGross":292.94,"totalNet":325.1634},"type":"dropshipment","userId":14718},"messages":[],"total":1}}}}}},"400":{"description":"Get Order by Id - 400 (invalid lookupKey)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"221"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 01:18:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"8bc64fbe-e85a-4361-938d-8b2cbeb867b4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"},"example":["Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Get Order by Id - 400 (invalid lookupKey)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [id1], key must contain one of the following values: [id,externalId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Get Order by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"163"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 15:41:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e1918395-a63c-9e8a-b346-e3deb080aa3d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [162222] not found"},"example":["Order with id [162222] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Get Order by Id - 404":{"value":{"error":{"code":15001,"messages":["Order with id [162222] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Order PDF by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/order-pdf-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order PDF by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupId}/pdf"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Generate a base64 encoded version of the order confirmation pdf based on the Propeller order confirmation template

Reference an order by a specific lookupKey / lookupId combination.

| **lookupKeys** |
| --- |
| `id` |
| `externalId` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupId","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Order PDF by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"21718"}},"date":{"schema":{"type":"string","example":"Thu, 24 Feb 2022 18:56:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"01511fec-9d3a-485f-b8fb-30a746ca0921"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"base64":{"type":"string","example":"JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE1MzQ+PnN0cmVhbQp4nK1Yy3LbNhTd8yvupjPtTAzjTdCryrFbt06dhzXJotMFbdGWHD4UinKarPIp+dRegKBISg7JNk0mdjA65+C+cHGhD8HpPKBgJCNRBPNFcD4PXgcfAkqoCBV8DDj8jp8/BIzCH8Gff1FYBB+AKQr2r5IEQZxBaELCJdxmcLzK7imcFfAaNRRlkYb93+W93fT4FwaGcAXzu4A5NYZ6lEQGjJBEwDwLfnxVFuskTYvyp/mDNe1bPKoIB8PRHFnzVmlRJfmmKuO4Aing5n5YQUbaBsAwRZhxEoyqCJ5fwCzbVEm5iLMRExgnSDBoiWZO4Op8fnH+5sXs6ux6ZG8jiNIYQ01k5KjnR1m8Sk9gld8VP6+bGJA8HbNBExZBGKIvdfwu316egJBMGK3UiBWhIgLJOiRCO/Lp/N0JXL0ghkaYupCwMCSnlI3ISE0UFgTi6ziezq4unQwG6M3s9CWhjDLCKVaM1l6rrqamLjhEXUVbXiJsMvu1oRCjtQ5h/3crEhK1J6OIUf2ygusij0tYbTDU98nmdlkmj0kON6sHWCRwGWdJCY9xDpdFsV7G+SJJocCfJeTbzH6GodUCTwqBi6QCDNiR/wAVr15gQXJhpDYYNQIv1xCnaQIpblHa7XL4vHrIUfBzArP0PsmSPIFudJ/y4QjLrHbibVGUH+O4XKCQtbEqknW82aAygbMENd9v8wq2kMcprnCf9ddlVa1Pjo831mnS1lWyPbaVVmZxtUqOY2/K0WO7AfFmoQGGU3tSskCFEnPZrNNmzRmhEpe8998dahm8C3KbPWj+YcYYJldpQ5hGXW7Qab9K21XEcNUA3WIZ3AVcyhaddYX2wC1wxxWcd7k9qQNCC97xJaVdfk/ugNCCW35ouvye3AGhBe/4SukeP+wFbo/Qgnd8zIjAP7D/u0mIjPBM7RJSr5qEKGrbnI9xs+gkpOF2hPbAHtjl+pDt9u1KHRA8uMv3IWv4PbkDggf3+KHp8ntyBwQP7vJ9jHf8sBe4PYIHd/l7p8JF2rGMPW4O75fpboltVjRZ2a282LcapAgdN8I7m1k7dWRt8Ou0XeN95ALn4X7pItWjNK62Cn7pGfuCbax3At6dRqBZNgJ9Pefe0JUhQgNKGNuObKe83t5URRWn/d4a9W8/Rhjrkk4G0Eq4UmrBMATmPWO+DOq6gaqDZuoZpQMM5yn2Vllf2dfL1Rp7dwW3xabaTPC3pQ77G3ahg97WoWnBw/5GdnzooKe4S7ntYe4KnM3xkvlhgp8tZ9TPFjrBzxY8xc8WLZ/xnp/i0E9pcAqu0fNp1WsZT2VTPGV6Rx6GwLxnyZdBXVe9HTQ/dJP1BhpBIcQzH9VGvyztaHVb5HcrN4sU+YDPruOFOHNEpjcYPhlOag0LFSc86uy0iKtkYAdGTUOTcrR2GHrPe2gujyg/4pTzcdPwxHctwynyJikn2IaFRdVk21o00xOM4sqO8u5BYt8jEC8WZbIZaiuNWcjU422lTiEVhEaHKdzDRvhGEqAN83EaqlnuTluLPUvSFc7cnyY44Kl4noy/O2I3779Nk+19ki6Lu6Gm4NmakbD2/tdkkWTrCi7sS+J9nMdxClyFEzQUavgrgAsJs9P2ITrEjqTdWuNzXo/3ar9VC/7Gk3W/CSvMGJ+cC9FPxm/5Y7G6TSblQnxfMsT/kQ3xPekQyvyrfIj/lBB3jjReouETrXAPq4WbMKLIflsx7SB1wPhwXmxv+5PFQe8A+xLUdZ+5ivtfnOyBWajsLdrinxeLZMggvN466FlW4Bt3yBguu/hX5ephA+vjIfsllnaHgiPGyJUnoy5+7Kq24cHh1l+Q51t8hMdDNeEj1FKi0ESUR4oxnFaGikLRPnGw8mxcWygb1OWuglr030Pu+ufiJCtctlro0EQl6iuqa/PI6Cipnm6JK4Jplsj6yuugxTOmBgh+cpxmiHs8TDOkeTxMD4l/2O/641DfqB+Y+JALxei4VbcNKZEi+xdwllTLYjGUVxaRmqqj0UHW7yP07nzHn9zrZ+o2yDS9XexX36+DfwDszggXCmVuZHN0cmVhbQplbmRvYmoKMyAwIG9iago8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtUm9tYW4vRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjUgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmRvYmoKNiAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0hlaWdodCAxNDYvRmlsdGVyL0RDVERlY29kZS9UeXBlL1hPYmplY3QvV2lkdGggNDAwL0JpdHNQZXJDb21wb25lbnQgOC9MZW5ndGggMTMzOTM+PnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFP/AABEIAJIBkAMBIgACEQEDEQH/xAAeAAEAAgICAwEAAAAAAAAAAAAACAkHCgMGAgQFAf/EAFwQAAEDAgMEBQQKDQgHBgcAAAECAwQABQYHEQgJEiETMUFRYRQiOHEyQlJ0dXaBs7S1FRYZIzc5YoKFkaGy0zM2V1iUlaKxFyRHcnODxBhDY4SSpSZTVpPU1fD/xAAcAQEAAgMBAQEAAAAAAAAAAAAABQYDBAcCAQj/xAA1EQACAgEBBQUHAwMFAAAAAAAAAQIDBBEFEiExQQYTUWFxMoGRobHB0RQi4SMz8DRDUmKS/9oADAMBAAIRAxEAPwC1OlKUApSukZr5t4ayXwlIxFieemJDb81plPnPSXOxttHtlH9QHMkAE18k1Fat8DJXXO2arrWrfJI7vUfM59uLKnJVx6FMvZxBe29UqtdjCZDiFDsWvUIQdesFXF4GoE7T+3LjjN6P9ibU89hLDUkr1gwnCHpDPsR0rw01CvPBQAE+aBz6zE/hqJsz1/t/Eu+J2ZkuOZLTyX3f4+JNjMjep4/vy3WMHWG14UiE6JfkgzpXgdVcLY79Cg+vvjvizapzfxstxV1zFxApLns2YkxURk+HRs8KdPkrF/DThqPlfZPnItVOzcWhf0619X8T2bnfLpe1E3G4zJ5JCiZTynCSBpr5xPPTlXrxJUmA4XIz7sZZHCVtKKSR3cuzlX5w04aw7xvKCS0O9Ydz+zOwksKtGYGJIIB16JF0eLZ9aCrhPWesVnXL7eZ5w4TdQi9vWzGMMHzk3CIGXgPyXGeAA+KkqqKHDThrLG6cfZkaluBjXrSytP3FtOUO8xyzx+6zCxO1KwHcnNAFTj08MqPZ06QOH1rSkeNS0ttziXmAzNt8pmbCfTxtSI7gcbcSe1KhyI8RWvFw1lPJHaVx/s/3RL+Fr04m3lXE/Z5ersN8a89W/anl7NBCuzXTUVv1ZzXCxFYy+zcJJyxZaPwfL4818y9alR12ZNtHB+0ZHTb06Yexg2gl2ySnQelA5lbC+XSJ05kaBQ56jTzjIqpaE4zW9F8Ci3UW403XbHRoUpSvZgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSldNzVzOsuT2Bbpim/PdHBhI1S0kjjfcPsGkDtUo8vDmTyBNfG1Fas9whO2argtW+CR1/PzP/Dmz7g9d3vbvTzn+JFvtjR++zHQB5o9ykagqUeQHeSAaks3s5cVZ7YwXesSTFSXieCLBZ16CKg6eY0js6hz5lR6ya485M379ndjqdia/PffXjwx4iVEtRGQfNab16gNeZ7SST1mumMqMduRJAJ6BorBSrhKVE8KVD1KUk/JVSysuWTLdj7J3HYuxKtkU97YtbWuL8PJfd9T4N7eRKuTpaIU0jRttSRoFJSNOLTs104vWTXocFc3BTgrxqbji3xZw8FOCubgpwU1Pm4cPBTgrm4KcFNRuHDwU4K5uCnBTUbhw8FOCubgpwU1G4edunS7PPjzoEl2FNjOB1mQwsocaWDqFJUOYII11FWk7E23G3m2IeBscOoj4zQ3wxLidEt3QJHUR7V7TmQOStCRoeVVZ8FcsSQ/b5TMmM85GksLS4080spWhYOoUkjqI011HVWem+VMtYkZtDZlW0KtyfBrk/D/PA2GKVGTYh2pE7QGBFWy9PITjayISiaOSfLGupMlI8TyWByCu4KAqTdWaE1ZFSjyOOZOPZiWyptWjQpSlZDWIabxHbZxVsdfaB9rNjs96+2L7IeUfZYOnovJ/JuHg6Naevp1a669Q8aw+dt/bNA57M5+SzXD+JXVt+d/sT/Tf/QVapQEGdmDeawc1cy0ZZ5mYQkZZ46edEaM1JUsMvyDpowtLiUrZdVr5qVahXVxBRSDmbbf2h71svZEysc2G2wLrcGZ8aII9x4+iKXFEE+YpJ1GnfUI99Vhq34bxXlNji18FuxQ/5ZHclM+a66mOphxleve2pxfPn7NPcKznvTbk9edhBm4SWizJlzbW+62faKV5xHyE6UBibCW8K2sse4ehX/Duz5FvVlmpK40+FbJ7rLoCiklKg7oRqkj5K79kPvTzfMzomXOc+ApGWWJJLyIyJbnStsoeXpwIeZdSHGQokAL1UPOGug1VWb9276EuVvvKR9LfqKO+8w5ak2DK/EIZbbv3lUuCHxoHHI/ChfCe1QSvmOwFxXuqAs7lSmYMZ2RIdQxHaSVuOuKCUoSBqSSeoADXWq5McbzXMTNjMa4YN2Z8tRjNEEqS7e7gw68lwcXD0qW0LbSy3r7Fbq/O1GqU9VZH22s2rxhvdtN3VchbN9xPZbVbn3upWsltsyQQefnNh5PeOLXsr726zytt+XmyJhi5sxUN3bE63rtPfGhU5q6tDI17g0hHLsJV1EmgMEI3jufWz3iS2RdorJ9u3YenL6NN0s7K2XAeslKi64y6pI/7sKQdOZPfY1g/Ftnx9ha1Yjw/OaullukdEuJMZJ4XWljUHvB59R0IOoOhFYx2x8soGbmzLmJh+dHRId+w8ibDKhzblMNqdZUD2HjQAe8FQ7TUZtzJmDLxJs6YgwzLdU8nDl7WmJxHUNx320ucA/5oeV+fQHq7Ue8IzWym2o7hlHgDANnxfIS1HXDZWzIdlyFuR0vKSEtuAHTVXUOoV1uTt47X1mYXOuezQ79j2Bxv9FaLgFBA6zqFK0GnPXQ6dddax9+O1w5/5b6pVVqtARe2NNvLCW13Dm29mC5hfGlub6aXYpD4d42tQkvMuaJ40BSgCCAUkjUaEE9I3hm3NizY/vOCYmGrDZry3fWJTr6rqHiWy0poAJ6NaevpD169lRnxxa4uUW+Sw6cKNpit3mdFdmRImgSlUuMUSdU/lcSnTr2q1A6q5t+L/OrKT3lcv349AZA/7b22d/Vn/wDZ7h/ErLmy3tL7RmaObDFizLyX+0jC64jzy7t9jpbPC6keYjidWU+cezrqZ1KAhPtX7c2LMgtqzLvK2z2GzXC0YlYtzsiZODvTtGROdjq4OFYToEtgjUHmTrqOVTYqpXeTfjI8i/edi+uJVW1UAqE+z3tzYszf2z8wcnLlYbNCseHJF2Zjz4od8pdESWGEcfEsp1IOp0A59WlTYqpXYe/GvZ3+/MS/WaaAtqr0LzeIOHbRNutzlswLbCZXIkypCwhtltCeJS1KPUAATrXv1Cfe6Zhy8D7I0m3QnlMuYmvEa0OlBAV0PC5IWPUfJwk6ditO2gMUXzeW5u56Y3uVh2asqhiK1wFcLl5u8Zx1S06nRwpDjbccK0PCHFKJA10B1A/bJvK838isa22x7SuVCcPWuerhbvNojuNFtOvNwArcbfCe0NqSoDnoToDJrd35XQMrNkTL1qJGbal3y3t36a+kDifclJDqVK9Tam0DuCB261+7xDLKBmhshZhsy46HpNkgLv0J5SdVMOxUl1SknsJbDqD4LVQEhLJeoGJLPBu1rlsz7bNZRJjSo6gpt5taQpK0ntBBB1quPN7eSZy4d2mMW5UYBy2s2LpNqmuR4jLceU9LfQhvjUopQ4AdBqeQHIVlTdFZgy8bbIsa3zHVPLw1eZVnZU4dVdFwtyED1DygpGvUE6dQFRsyb/HR4p9+3T6CqgO4XreRbS2WEcXvMLZ0XAwy0QJEhMOdCSjmNNX19IhHcOJPM1NrZj2nMI7VeXSMU4VW7HUy55PcLXK0EiC/prwK05KBHNKhyI7iCBlS52yJe7bKt0+M1Mgy2lsPx30hSHW1ApUlQPWCCQRVUe5+eVYto7OTDdrcUvDqYalI87jBLMstsniHIngcXz7aAtopSlAKql289oJWbGZa8NWqTxYWw44phvoz5smV1Ou+IHNCevkFEezqd+15m+rJjI693aI90F5mgW22kdYfcB84eKEBa/Wkd9U3Kc1JOupNQO0r2kqo+86Z2P2apyln2Llwj69X9vifteE1bX2McR5wfU6jh06igBXF+0pr8JJr7+HsFX3MR+1WLDVolXq7vyHyiPFRxK04WvOJ9qkdqlaADmSKgoJt8DpeRNRrbk9EdJ4PCvu4PwBiLMG6i24asc++zjzLMCOp0pHerQeaPE6CrA8iN2TbLc3HuuaM83OXyX9gbY6UR0fkuvDRSz4I4QNPZKFTZwpgyxYFtDdrw9Z4VltyPYxoLCWUa9+iRzPieZqapwJz4zehzvO7TY9DcMZb78eS/krCy/3Y+ZuJ0IfxFMtWD46utp9zyqSB38Dfmf4xWfsLbq3AVvbQq/4qv16eT1iGlqG0r80pcV/iqblKk4YVMOmpT7+0G0LnwnuryWnz5/MjVbd3fkVBRo9hSTcTp7KTdZQP+BxIr3vufuQf/wBBf+8T/wCPUh6Vn7ir/ivgRr2lmt699L/0/wAkWLzu2slbohYjW27Wgq10VCua1FPq6UL/AG61ijGG6htTqFrwrjuZFWOaGLxDQ8D4Fxso09fCan9SscsWmXOJs1bZ2hU9Y3N+vH6lOeZOwHnBl0h2Qiwt4ogNgkybA75QoAf+EQlwnTuSR41HmVBegyXY8lhyO+2rhcadSUqQodhB6j662Eqxpmzs84AzthLZxXh6NMlFPC3cWk9FMa5cuF1PnaD3JJT3g1pWbPXOt/EsmJ2qnFqOXDVeK4fL+UUacHhTg8Kk7tcbGy9nAwLrbb8i74ducgxoyJaejlNOBJWEKI8xeqUnmOEk8uHq1jQpsoUUqSUqSdCDyIPdULZCVUt2a4nQcXIpzKldRLVM7dk5mld8lcx7Ni6zHWTAd1cYKtEyWTycaV4KSSOrkdD1gVeHgjGNszBwjaMSWd/ym2XOOiSw528Kh1HuIOoI7CCKoO4PCrHN13m+q44fv+XE57Vy2qNztqVHn0C1APIA7krKVet01I4F27Pu3yZU+0+z1bQsuC/dDn5r+H9yelKUqwnLCqvfnf7E/wBN/wDQV2r7rtjj+rDiD+93/wD9fXVd+d/sT/Tf/QVapQFR8LJ/PDeT59YcxZmdhCRl/ljY+EJiS2HGAtjjC1tMpd0W646QEqd0CQEj3ISZM73VsN7GlwSkBKReYAAA6vPVU16hVvePQ3uXwzB/fVQEVNmHbTz/AMrsgcKYdwps93fF2GLbHdTFvzFrnuNSUF5xalBbbZQQFKUnUH2vrr4OU9kx/vZ8+W75jy62u0YIwh0XlNot6yhTcd1ZV0UdslSit0taLeUdAANNdEoqwndu+hLlb7ykfS36gu+79z13mZWSbflzjRziVz4WGoUxzme4CPIST3htH5fMCR++IYbjbIVvZZbS003iSElCEJASkBmRoAOweFZu2A/Q3yn+Bk/vrrqu82y3mZkbHONG7e0p+dZize22kp4iUMOAvHw0ZU6rl7nTtNfD3VeblszG2TcP2NqU2u+YTW7a58biHGhJcW4wvh6+FTakgHtUhY7KAk3mz+CzGXwNN+YXVdW46/mtm379tvzcippbaGacDJ/ZizDv06SiO87aX7fBSo6KclvtqaZSkdp4lcR06kpUeoGo37mrLmZhbZxvmJprKmRia9Lciaj+UjsIDQWP+Z0w/NoCNG13mlMyW3qSsawMOv4tmWlqG63ZozpbcklVuCOEKCFkaBfFySer5azNJ3tWY05hbFs2Zb4i4ODhYU5cJL6Qvs1bTCSVDwCgfGus4+/Ha4c/8t9Uqq1WgK09iTZWzTzC2kbhtIZ425yx3Za3H7daJbJafU8proUqLKiVNNNNeahC/O1CT7XVXQd+L/OrKT3lcv349W1VUrvxf51ZSe8rl+/HoDIH/ZQ29f6wOH/71l//AINSc2O8rs88sbdidrOzHkDHMqY6wq2OQZTr4jISF9KD0jLWnEVI6ters7ZHUoCpXeTfjI8i/edi+uJVW1VUrvJvxkeRfvOxfXEqraqAVUrsPfjXs7/fmJfrNNW1VUrsPfjXs7/fmJfrNNAW1VXVvtPwB4F+Mw+iv1YrUKt7flxLx5sjS7hBaU89he7Rry4htPEos8Lkdz5EiRxnuCNeygM/7Jvos5N/EyzfQWabWXos5yfEy8/QXqxzu5c3LbmvslYFTElNuXHDsFuwz4wUCthcdPRt8QHUFNJbUD2g+Brk3i+advyu2RMfqlSUNTb7BXYYTJVop9ySOjWlPfo0XFHwSaAwFuS/wB46+Mx+isVFfG2ZWL8o96Fj3E2BsHyceYjjXKYhixxGHnnHkrjcCyEtArPCklXIdnOp07pHLmZgPZEhzpzKmXMTXeTemkrTooMlLbDZ9ShH4x3hYPbUacm/x0eKfft0+gqoD4+0NvMtoiFhb7W7nlevKGZfW3GGbnc4UuNJU3oErMcyAhKSONOq9Dw6jqOhEyt3fsaK2T8ubjLvcyLcsZ4lLT852CvpGIzKAromG1+29mpSlDQEkAahAUeHeg5AjO3ZjulxgRumxDg8qvcMpT562Up0lNjwLWq9BzKmkCvDdebQf+m/Zpt9ruEvp8S4OUmzTeNeq3GAnWK6fAtjg1PMqZWaAmDSlKArU3nuYi7vmNh3BzDmsWzwjMfSD/3755AjtIbQgj/iGoU6isp7VWK14w2iswLipZcCbs7EQrvQx94T8mjYrFBOtUzJl3l0peZ+hNk0LFwKal4LX1fF/NnmV1ZTuto7H+ivFsjomxJN64FO6DjKegbITr3ak6D11WjxVYbup72l20ZiWk6BTL8KUnvPGl1J/VwJ/XWxgNLIXvIntOnLZc9OjX1RPqlKVaziIpSlAKUpQClKUApSlAQg3sjbRyKwq4V6PJxI2lLfekxpHEfk0T+uqxLfegUpYmkqbACUPAaqb06tfdJ05adY5adWhsm3tlzS3lngW3cuN+7uyB6m2Sk/OiqwKgMzR2vU6h2fbhhRkn1f1O1raUjhOoUhQ4krTzCh3j/+8DWXNkrMBeWe0Lgu7FzgivTU2+Xz83oX/vSie8JKgv1pFYLtF3ML7w8C5EWdSkdaD7tPjy5jqI5dYBHYE8bDiHGnCCNFtuoJHqUP86i+NUlJF00hm0zpn1TT960NgClddy9xMnGmAsNYgT1XW2xpw5afyjSV9X51diq5J6rVH59lFwk4y5oh9vA9iK+bZBwGLNiW34d+1zy/pfLmVudN5R5Ppw8PVp0B117xUwaUr6eRWBttPZ1uO1HkfJwLarvFskt6dHliXMbUtADaiSNE89TrWeaUBinZcyemZBZC4RwBcLgxdZlkYcZcmRkFLbpU845qArmPZ6Vi3b02Kk7YeE8OMW66xbBiSxy1rYuEtpTiFRnEaOtEJ581JaUD2cJGnOpUUoDouTmEr/hLKTDeGcY3ONiG+W6AmBMuDKD0csIHAlZCuZKkBPFr1niqEGY262xTgrMaZjTZxzLcy5kzCortEl59lloFXEW0PNBRUzrp97WhQGg5nkBYzSgKz4G7EzfzmxVbZ+0LnOcSWiAsKTbLRJkSStPalCnUNoYKgOaktqJ/aLGMK4VtWCMOWzD9igNWyzWyOiJEhsDRDTSBolI+QdZ5nrNfYpQEPsR7EV8ve3rbM/kYlgNWeJ0XFZ1Mr8oVwQzH5K9j1nX1VMGvQu16t9giKl3OfGt0UEJL8t5LSAfFSiBXVbfnnlvdpSI0HMDC02Sv2LMe9RlrPqAXqaA7zUM9v7YUvu2Jd8GTLNie3YeTYWJTTiZzDjhd6VTZBHD1adGevvqZKFpcQFJIUk8wQddRXnQFav3PXan/AK12IP77un8asp7M+yBnvlLm9asS45z8u2PMORmn0P2OVc577byltKShRS64UHhUQrmOzlU16UBBfbe3fmLdqHO3D2PsNY3g4UctFnj29rpW3enQ81JfeDqFoI4dOmToQdQU61j37nrtT/1rsQf33dP41WVUoCL+x1s45sZE3LFD+ZOblxzNYuTUdEJqdOlyREUgrK1Dp1q04uJI5aa8POo24x3XWaz+emOcxMFZxs4LlYivE+4NuWsyoslpmTIU90SnGlJJ606gHQlNWZUoCtX7nrtT/wBa7EH993T+NUy9nvKLEeXuR0XBOZGKHMyLqrypufc7k67J8rZdWr72svFSlJCFcGhJGnLqrL9KArZxTuucf5WY5uGI9m/Nh3BDE4+fablJkMpbTqSGy80lfTIBJ4Q42SO1SjzrxwzuvMx81sc22/7R2bS8aQ7erVNotsqQ+l1GupbDrqW+hQrQcQbb1PPQg+dVlFKA9K0WqHYbVDtlujNQYENlEeNGYSEoabQkJQhI7AAAAO6ogYI2Fb7hTbru+fTuJrc/aZr8t1NoQwsPp6aOWhqr2PInWpmUoDieaRIaW24hLjaxwqQoahQPWCO2oVbK2wTiTZW2iMTYssWLre/l/ehIYOHyy4H22CsuRhxexK2jonXlqkq79Km1SgFKUoCgjEd1N6xBc7iTqZcp1/UjTXiUVa/tr5nFXJLYXClPMO/yjS1Nq0Oo1HL/ADFeuV91UbQ/SKaSSXI8ye+pbbszGaLFn/Jsjrmjd9tTzLSdet5opeH+BD1REJ1rtuUWPXcr8zsMYqZClfYqe1JcQnrW0D98T+cgqT8tZ6Z93ZGXgRu0aP1WJZT1knp69PmXx0r1YM6Pc4UeZFdRIiyG0utOoOqVoUNQR4EGvaq5HABSlKAUpSgFKUoBSlKArD3s+Kkz8xcD4bS4FG22x6cpI9qZDgTz+SMDp2Dn21AsprOW2XmGjM/aRxpdmHA5BjyvsdFUk6gtxx0XED2hSkqV+dWEiKrN09+yTR2LZ2O6MOqD56fXievX2rJdw2kQ5J+8k/enD1tK7v8AdPd2HmO0H5RTXGRpWFpSWjJGMnXJSjzL0NkSU7M2a8v1PpWhxu3BgpcGhAbWpA/YkfJWYqwRsONPMbKWXKX+azAWoaq180vOFP8AhIrO9Wer+3FeSOM5r1yrX/2f1KgN95+FPLX4GkfP1WtVlO+8/Cnlr8DSPn6rWrKaRtUUpSgFRU3o/oK5mfoz6ziVKuoqb0f0FczP0Z9ZxKAoCq9PdD+hvbfhmd++mqLKvT3Q/ob234ZnfvpoCatV47wXeVuZH3OXlzlg5Hl42aHDc706hLrNrJAIabSdUuPaHU8QKUdRBVqEyu2s87Rs8bPuMsdI4FXCBE6O3tucwuW6oNM6jtAWtKiPcpPVWuFc7nLvdylXC4SXZk6W6t9+Q8oqW64olSlKJ6ySSSaA+1jzMjFWaN9cvOL8Q3LEd0XrrJuMhTygDz4U8R81PgNAOwV1qp5bujd72/aagT8dY9emRsExJBhw4MNfRu3J5IBcJX1paRqkap5qUSARwHWwPFO632csR2BdtjYIdw+/wcLVxtl0k+UNeP31xaVH/fSqgKcchNrzNTZwujD+DsUym7ahQU7Y5qy/b3x2gsqOiSfdI4VflCrxtkDa4wztcZd/Zu1JFsxBA4GbzZFr4lxHSOSkn27S9FFKtOwg6EEVRntWbON42Wc5Lrge6yPL46EJl265BHAJsRevA5w6nhOqVJUOeikK0JGhPYNhjP6Vs7bSGFb+ZSo9hnSE2u9NlWiFw3lBKlqH/hq4XR4t6dpoDYnqgHej+nVmZ+jPqyJV/wBVAO9H9OrMz9GfVkSgMf7FHpb5Q/GaD86mtj6tcHYo9LfKH4zQfnU1sfUBH/b89DfNj4GV++itdetijb89DfNj4GV++itdegLqdyp6LOKfjnK+gwa+rvkvRHh/GaF8zIr5W5U9FnFPxzlfQYNfV3yXojw/jNC+ZkUBSDWwnu3fQlyt95SPpb9a9lbCe7d9CXK33lI+lv0BGrfefgsy0+GZPzAqoGrft95+CzLT4Zk/MCqgaA/QSk6g6HwrKWWm1Hm1k/Nak4TzBvtrDZ4hFMtT0VR/KYc4m1fKk1aJkXutsjMxMisvcT3WHfRd77hu33KW7HuhSnpnorbiylPCQBxKOg5gVHjbY3V/+gvBE7H2W94n37DltT0tztd14FS4rXa+hxCUhxCdfOHCFJHPVQB0AkvsN70G357XaDgTMhiHh7G0jRuDcmDwQ7mvsb4T/JPHsGpSo8hoSEmwGtVyPIcivtvMuKadbUFoWg6KSRzBB7DWwTu9tpB/aU2c7Td7tI6fFNmcNovCyfOdebSCh4/8RtSFE6AcXGB1UBV7nbYFYTzjxvZ1JKBCvUxlA5c0B5fCfURoeyuklVSe3jWBF4P2krjcUo4YmIYbFxbI6gsJ6JweviaKvz6i6TVOuhuWSj5nfcHIWRi12rql9DyKq/Cda8CvurxJNY9Da3i3Hd4ZzozLyNj2CXI6S94UKbe6lR85UY6mOr1cILf/ACvGpU1SPsoZ9PbPmcNtvzilqsUr/UbuwjnxxlkarA7VIUErHaeEp1Gpq623T412gx5sN9uVEktpeZfaVxIcQoapUk9oIIOtWfDt7yvR80cd2/g/pMtziv2z4r16r4nt0pSt4rQpSlAKUpQCsTbUObjeSWSOJcTpdDdySwYttTy1VLd81sgdvCSVke5Qqss1VbvJs+hmBmPHwJapAcsmGVEylNnUOzzyX6w2PM8FFzr5Vq5Nvc1t9ehM7IwXn5ca2v2ri/RfnkQvc1WoqUdVE6knmSa4ymvYKa8CnWqxqdkcT1imvApr2Cmu25PYBdzPzVwphVtKiLtcWYzpT1oaKvvq/wA1AUr5K9ri9DWsahFzlyXEuy2dsNqwjkTl9Z3EdG9FsUNLyNNNHSykuf4iqsjV4IQlptKEJCUJGgSBoAK86tqWiSOHTk5zc31epUBvvPwp5a/A0j5+q1qsp33n4U8tfgaR8/Va1fTwbVFKUoBUVN6P6CuZn6M+s4lSrqKm9H9BXMz9GfWcSgKAqvT3Q/ob234Znfvpqiyr090P6G9t+GZ376aA6Jvq8UPW7IHBtjbUUN3PEIfdI9slmO5on1cTiT+aPlpnq2jfi/zWyk9+3L5uPVS9AbF+wnhCPgnZAyngRkJQmRYY9zVw9q5SfKVH16ums81inZN9FnJv4mWb6CzWVqAqy34GEWDByqxQhtKZSXZ1tec7VoIacbHqBDv/AKjVUlW/b7z8FmWnwzJ+YFVA0Bs0bP2KXccZEZc4hkudLJuuHLdNeXrqS45GbUvXx4iapB3o/p1Zmfoz6siVcnsU+iPlB8WYPzKaps3o/p1Zmfoz6siUBj/Yo9LfKH4zQfnU1sfVrg7FHpb5Q/GaD86mtj6gI/7fnob5sfAyv30Vrr1sUbfnob5sfAyv30Vrr0BdTuVPRZxT8c5X0GDX1d8l6I8P4zQvmZFfK3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrIOKMOwsX4Zu9iuLfS2+6RHYUls+2bcQULH6lGsfbJvos5N/EyzfQWaytQGrBcIK7bPkxHSlTjDqmlFPUSkkHTw5VZbuQ8XyI+O8zMLFalRZdti3MI9qlbTqmyfAkPj18I7qryzSaQzmbi5ptCW20XeWlCEjQJAeXoB3DSprblT0psU/EyV9Og0BODeaZTKxjk/BxhCYLlwwvI4nikecYjxCXPXwrDSvAcRqq0nvrYIxDYYOKbDcbNdI6ZduuEdyLJYX1ONrSUqSfWCaozz5yhuWReaV7wjcQtYiO8USSpOgkxlc2nB6xyOnUoKHZUFn1aSVi6nSuzGcp0yxJPjHivR/z9ToRVXiVV414lVRWhdnI8tTVh+7j2r0BuNlLiuYEqB/+H5jyuvXmYhPf1lHyp9yKrsKq/WZDkZ5DzTi2nW1BSHEEhSVA8iD2HXtFbFNjplvRIvPxK8+h02e5+D8TYjpUMNiHbfYzfixcEY3lNxsbsI4Ys1eiUXVAH6g8ANSn23WO0CZ9WauyNsd6Jx7KxbcO11WrRr5+aFKUrIagpSsc54524fyFwJKxLf3Cvh+9xILagHZjx9i2jX9ZPUBqefVXmUlFb0uRkrrndNV1rWT5Ix/tl7SkfZ+y3dRAeQrGN3Qpi1R+stctFyFDuQDy161cI0I4tKc5Lzsp9x59xbzziitbjiipSlE8yT2nt1Nd3zezUv2dWO7hirEMjpZkk8LbIJ6OMyD5jTY7Ep1+Ukk6kknpJGtVbJyHfPVclyO1bI2VHZmPuvjOXN/b3HrlOlcZTXslNcak1rJkw4nrkVODda5SLvmY16zAlM/6jYo5hQ3D2ynk6K0/3WuIH/iioYWiyzcQ3eFardHXMuM15EePHbGqnXVq4UpHiSQKvA2c8nIuRGUNiwkz0bkthvpp8hvqflL5ur8Rr5o/JSmpLCq7yzefJFP7R5axsXuU/wB0+Hu6/gyfSlKsRykqA33n4U8tfgaR8/Va1WU77z8KeWvwNI+fqtagNqilKUAqKm9H9BXMz9GfWcSpV1FTej+grmZ+jPrOJQFAVXp7of0N7b8Mzv301RZV6e6H9De2/DM799NAYZ34UZxWDcp5ARqyifcG1K7lKbYIH+FX6qqSq7DfLYHexDsw2m/x2uNWH7+w8+vT2DDzbjJP/wBxTAqk+gNlLZN9FnJv4mWb6CzWVqjPu48xouZOx5l88w8lyTZon2Clt8WqmXIx6NKT3atBpYHctNSYoCtXfefgsy0+GZPzAqoGrPN9vmPEn4qy2wNGeC5VtjSrrNbSrUJ6ZTbbIPcdGXT6lDv51kR47kp9tlltTrrighCEDVSieQAHaaA2Odi1tTWyVlClSSlX2sQFaHuLKSD+o61TXvR/TqzM/Rn1ZEq9HKTCCsvsqcGYWWAFWOywrYQDxAFlhDfX2+x66o13p0N2Nty5huOJ0RIbtrrZ70/Y6Mj/ADQoUBjjYo9LfKH4zQfnU1sfVrd7GsxmDtYZQvPuBpsYot6eI9QKn0JH7SBWyJQEf9vz0N82PgZX76K1162F94rd27JsW5pyHdOFy3tRhqrTznZDTQ/ascv8q16KAup3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMivS3L8B2HspX11waIlYtlvNnvSIsRH+aFV7u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrK1Yp2TfRZyb+Jlm+gs12TOHMaDlFlZivGdycQ3DsduemnjOnGpKTwIHipXCkDtKhQGtbmPMRcsw8US2goNSLpKdSFciAp5RAPjzqb+5VZcVtP4rdCSWk4OkoK+wEzYRA/Yf1VAB11ch1bjq1OOLPEpajqST1kmrTNyFl490+ZuOnmuGPwxrLFd09mrm8+nw0Hk58eLwoC1iou7dOy7/p8wAm72KOlWNrE2pcMDQGazrquOT39aka+21HLjJqUVKxzgrIuMjZxsizFtjdU+KNd19pyM8408hTTqFFK21p0UlQPMEdhrj1FWW7eGw6vFqp+ZOXsLivYBeu9kjp5zABzfZA63fdI9v1jztQqs5WoJB1BHLSq1bTKmW7I69g59WfUrK+fVeDPIqrx4q8eKvEqrFob28czEl2I+2+w6tl9pQWhxtRSpCgdQQew689RViWyfvJG+hh4UzcklK06NRcU8OoV3CUB1Hs6QdfLiA5qNcpVXjxVsVWSqlrEjczDpzq9y1ej6r0Nie33GLdoLEyFJamQ5CA40+wsLbcSeYUlQ5EEdor26o82dtqnMvIi4JjYXnG52Qq437FcNXYhB5FQ5joTqR5ySka6cWoGlSxzF3nFzueEI0XCOG0WTEL7X+tzJbyZLcRfaGRwgOH8pQ0HuVddSv66pR1nwZSH2azZWqFC3ovry09f41JZbQO0xhLZ7sJkXiR5be32yYVkjKHTvnmOI+4RqPZHuOmp5VUtnPnPibPPGL2IMSy+kcOqY0NokMRG9fYNp7B3nrJ5kk113EeILni69S7veZ79zuktZcflSVla1nxJ8OWnUByHKvlEd9QWTmSyHpyj4HS9kbBp2VHe9qx839l4fVnrlNcZTXslNeBTWnqT7iespOlcZTXslNS92K9il7NmZFxrjOMuPgtlfHFhLHCq6KB/WGQRzPtuodpGequV0t2BFZuVTg0u656JfPyRkjdybLS4QazZxPE4XXEKTYIjydCEEaKlEeI1SjXsKlac0mrBa4WGG4rKGWUJbaQkJShA0SkDqAHdXNVtpqjTBQicOz82zaF7vs68l4LwFKUrMR5UBvvPwp5a/A0j5+q1qt93rOy7mjn9mDga4YAwjJxJDt9reYkusPsthtZd4gD0i09ndUFvub20j/RbcP7bE/jUBKr7uLfP6JLf/AH4v+BT7uLfP6JLf/fi/4FRV+5vbSP8ARbcP7bE/jU+5vbSP9Ftw/tsT+NQFgmynvUrptIZ+YWy6kZdw7EzevKuKe1dVvKa6GK8+PMLSddei4esdevhWZd6P6CuZn6M+s4lQb2AtifOzKLa2wJizF+AZllw9b/L/ACmc7JjrS30kCQ0jkhwk6rWkch21YTt+5b4kzc2SMd4TwjanL1iG4eQeSwWlpQp3o58d1fNZAGiEKPMjqoDXdq9PdD+hvbfhmd++mqwPub20j/RbcP7bE/jVbbu2spcW5KbMkHDONbK7Yb43dJb6obziFqCFqBSrVClDnp30BnPOXK+2Z05V4owPeOUC+QXIinAniLSyNW3QPdIWErHikVrb5p5Z3/JzMG+YOxPDVBvVokKjvtkHhXp7FxBPskLSQpJ7UkHtrZ8qM+2LsLYM2ubM1ImOHD+NILJbgYgjNBauHrDT6OXSt6nUDUFJJ4SNSCBTzsf7bGMNkDEM120Rmr/hm5FKrhYJbpbbdUnkHG1gHo3NOXFoQR1pOg0mrijfe2/7X3BhzK6SL4tGiDdLmkxmld54EcTg8PN17xUTc092Pn/lnPdQzg9WL7cFEN3DDbokpc/5XJ1Pyo08TWIbpsw5wWOzz7rdMq8Z2u2QGVSJUydYJTDTLafZKUpbYAA6yewc+ygOvZrZo4izozAvWM8VTjcL5dXumfd00SkABKUIT7VCUhKUjsAFST3ZWzLMz42g7Xfp0NasH4Pfauk99SfMdkJPFGYHeVLSFEe4QrXTUaw+q3zdV7Y2X72C7RkvOtUDBeKGVkwpDOoYvrqvZLUpRJEk6AEKOigEhGgAQALLKqS30uRsuHivCebECKpdumxhY7m6gcmn2ypbC1f76FLTr1DoR3jW22uu4/wDYM0sG3bCuKLY1drDdGTHlRHtdFpPPUEc0qBAIUCCCAQQQKA1grfPk2qdHmxHlxpcdxLzLzZ4VNrSQUqB7CDodatHyx32Rg4XhxMeZfP3K+MNBD1ys01DbcpQ9uWVI+9k9ZAURr1ADkMf7RG55zAwjd5U/KiSxjXD61FTVtmSG41xjp9ySspbdA90Ckn3PfFK7bG2e1klGPIygxq4sdsOxyJKP/U0hSf20BmjbZ3j192ssPRMJW3D6cI4PZkJlvx1SzIkzXU68HSKCUpShPFrwAHzgCVHQAQ7ixXp0pqPHaW/IdUG22mklSlqJ0AAHWSeWgrP+B937tB49lNswcrr3bkq63r42LchA7z05QfkAJ8DVk+xJuurVkHfIWN8w5kPFONI33yDBjIKoNtc/wDmAqALro7FEAJPMAkBQAkVsWZKv5AbM+CcHz2w3eGYqpdyA6xKfWp1xBPaUFfBr3IFYG3yXojw/jNC+ZkVOqoj7zjJ3GWeOzjGw5gaxvYhvSb9GlmIy42hQaS28FK1WpI5FSe3toCg+thPdu+hLlb7ykfS36qA+5vbSP8ARbcP7bE/jVc9sPYBxBlbsr4Awrim2uWe/wBtivNyoTi0qU0TJdWBqkkHzVJPInroCJe+8/BZlp8MyfmBVQNXfb1nILH+fuX2BbfgDDb+JJlvubz8lph5pvo0Ka4QT0ik9vdVav3N7aR/otuH9tifxqAkDllvib1llldhPB0fLKBOGH7NEtDU127rT0vQMoaDikBrlrwa6BXhr21H/aj2+8ztqqG3aL89DsWFWnQ8mx2ZCkNOrHsVPKUpSnCOwEhIPMJB51+p3bm0itQSMrZ4JPWqdDA+erKWWe58zwxdMa+2j7C4Eg8Q6VcyaiZICe9DccrSo+CnE+ugIbYFwRfMysXWrC+Grc9db7dHxHiQ2BqpxZ/YABqSToAASdADWxRsoZAQtmXIvDmBoy25E2M2ZNzmNg6SZjminVjt4ddEp158KE611XZR2HMvdky2rdsbLl6xXJa6KZiO4IHTrTrqUNJHJpH5KdSdBxKVoNJF0ApSlAKhptb7vu0ZxuzMV4HMewY0Xq5IjL82JcVdpVp/Jun3Y5KPshzKhMulY51xsjuyRtY2VbiWKyl6P/OZr343wBiPLfEj9gxPZpdmvDJ0VFkt6KI7FJPUtJ7FJ1B7zXot4YurjoaXCXHUocQ8q0YBHrXprV+GY2VuF82LA7ZsVWhm6wljzePVLjR70LSQpB8QR8tQpzN3X7yVPSsAYpStPMpt19ToQO4PNj/NHy9tQt2JbDjWtUdF2dt3DyFu5cu7l6ar49PeveV2sYVcUgLflssni4VNJ1WsDXrGg4T3+yr6DFitsbrQ7NVqRxPK4EkacvNTzB/OI8KyxmDs05m5Xl1V/wAH3FmIgnWdFb8pjad5cb4kp79FaHwrGVQ052RekloX7HoxbY79UlNeKeq+R5qeUW+jGjbWvF0TaQhAOgGvCOQOg6+2vClK1ufMlElFaJCvwjWv2uy4My0xZmHJEfDWHbnfHOLhJhRlOIQfylAaJHidBX1JyeiPM5xrjvTei8zqxTpXPbbRMvlwjwLdEfnTpCw2zGjNlxxxR6glI5k+AqZGVO7SxfiFTMvHN0j4WgnmuFFIlSz4aj72j16q9VTfye2csBZGxAnC9jbbnqRwO3WV9+mOjt1cI5A8vNQEp8KlacC2zjL9qKZtHtRg4qcaH3kvLl8fxqRM2X93apl6JibNVhCtNHY2GQriGuvIyVDkR29GNfyj1pqfseO1EYbZZbQ0y2kIQ2gAJSAOQA7B4Vz0qx00QojuwRybP2jkbSt7y+Xoui9BSlKzkYKUpQClKUApSlAKUpQClKUApSlAK43G0PtqQtIWhQKSlQ1BFclKAqf3hO7HXbjdMzMnrYXIhK5V3wpFTzZGmqnoiR1p6yWRzHtBp5ohvsh7HuM9q/HCYVjC7Rh2CtKrniR1tRZiDrCUdXG8exAI7yQOdbFFfKsOGrRhWI7Estsh2mK6+5JWzBYSyhbriipxZCQNVKUSSesmgPHClg+1bDNqs/2Qm3XyCM3F8uuTvSyZHAkJ6R1eg4lnTUntPOvr0pQClKUApSlAKUpQClKUApSlAKUpQClKUApSlAKUpQClKUArGebWWWD8Q4fnz7rhOx3OcACJMy3Muug6jnxKSTSlaeV7BObG/wBUirPPOxW20vSPIbfFh6ON6eTsJb08zwFY+wDGZmXwIkNIfRwK81xIUOrxpSqjL2zvVf8AZ934LPNmnKTA0y0KmSMGYefltrHA+5amFOJ5HqUUaipJxI7UOK2yw2hhpCdEttpCUj1AUpVowvZOMdo/76PapSlSRUBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoD//ZCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldL0ZvbnQ8PC9GMSAzIDAgUi9GMiA0IDAgUi9GMyA1IDAgUj4+L1hPYmplY3Q8PC9pbWcwIDYgMCBSPj4+Pi9QYXJlbnQgNyAwIFIvTWVkaWFCb3hbMCAwIDU5NS4wMSA4NDEuOTldPj4KZW5kb2JqCjcgMCBvYmoKPDwvS2lkc1sxIDAgUl0vVHlwZS9QYWdlcy9Db3VudCAxL0lUWFQoMi4xLjcpPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDcgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjIwMjI0MTg1NjQyWikvQ3JlYXRpb25EYXRlKEQ6MjAyMjAyMjQxODU2NDJaKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxNTQzMiAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2MTcgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDAxNzk1IDAwMDAwIG4gCjAwMDAwMDE4ODQgMDAwMDAgbiAKMDAwMDAxNTYzMSAwMDAwMCBuIAowMDAwMDE1Njk0IDAwMDAwIG4gCjAwMDAwMTU3MzkgMDAwMDAgbiAKdHJhaWxlcgo8PC9JbmZvIDkgMCBSL0lEIFs8MTRmMjhmN2Q5NDdhOTM0MzNiN2QzZWNiZWZlNDRiNjc+PDZhMDJkZTJjODNiZGQyMjViODE4NjE2OTE5NTdiZmI3Pl0vUm9vdCA4IDAgUi9TaXplIDEwPj4Kc3RhcnR4cmVmCjE1ODQ5CiUlRU9GCg=="},"contentType":{"type":"string","example":"application/pdf"},"fileName":{"type":"string","example":"order-162.pdf"}}},"messages":{"type":"array","items":{"type":"string","example":"PDF created"},"example":["PDF created"]},"total":{"type":"number","example":1}}},"examples":{"Order PDF by lookup key - 200":{"value":{"data":{"base64":"JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDE1MzQ+PnN0cmVhbQp4nK1Yy3LbNhTd8yvupjPtTAzjTdCryrFbt06dhzXJotMFbdGWHD4UinKarPIp+dRegKBISg7JNk0mdjA65+C+cHGhD8HpPKBgJCNRBPNFcD4PXgcfAkqoCBV8DDj8jp8/BIzCH8Gff1FYBB+AKQr2r5IEQZxBaELCJdxmcLzK7imcFfAaNRRlkYb93+W93fT4FwaGcAXzu4A5NYZ6lEQGjJBEwDwLfnxVFuskTYvyp/mDNe1bPKoIB8PRHFnzVmlRJfmmKuO4Aing5n5YQUbaBsAwRZhxEoyqCJ5fwCzbVEm5iLMRExgnSDBoiWZO4Op8fnH+5sXs6ux6ZG8jiNIYQ01k5KjnR1m8Sk9gld8VP6+bGJA8HbNBExZBGKIvdfwu316egJBMGK3UiBWhIgLJOiRCO/Lp/N0JXL0ghkaYupCwMCSnlI3ISE0UFgTi6ziezq4unQwG6M3s9CWhjDLCKVaM1l6rrqamLjhEXUVbXiJsMvu1oRCjtQ5h/3crEhK1J6OIUf2ygusij0tYbTDU98nmdlkmj0kON6sHWCRwGWdJCY9xDpdFsV7G+SJJocCfJeTbzH6GodUCTwqBi6QCDNiR/wAVr15gQXJhpDYYNQIv1xCnaQIpblHa7XL4vHrIUfBzArP0PsmSPIFudJ/y4QjLrHbibVGUH+O4XKCQtbEqknW82aAygbMENd9v8wq2kMcprnCf9ddlVa1Pjo831mnS1lWyPbaVVmZxtUqOY2/K0WO7AfFmoQGGU3tSskCFEnPZrNNmzRmhEpe8998dahm8C3KbPWj+YcYYJldpQ5hGXW7Qab9K21XEcNUA3WIZ3AVcyhaddYX2wC1wxxWcd7k9qQNCC97xJaVdfk/ugNCCW35ouvye3AGhBe/4SukeP+wFbo/Qgnd8zIjAP7D/u0mIjPBM7RJSr5qEKGrbnI9xs+gkpOF2hPbAHtjl+pDt9u1KHRA8uMv3IWv4PbkDggf3+KHp8ntyBwQP7vJ9jHf8sBe4PYIHd/l7p8JF2rGMPW4O75fpboltVjRZ2a282LcapAgdN8I7m1k7dWRt8Ou0XeN95ALn4X7pItWjNK62Cn7pGfuCbax3At6dRqBZNgJ9Pefe0JUhQgNKGNuObKe83t5URRWn/d4a9W8/Rhjrkk4G0Eq4UmrBMATmPWO+DOq6gaqDZuoZpQMM5yn2Vllf2dfL1Rp7dwW3xabaTPC3pQ77G3ahg97WoWnBw/5GdnzooKe4S7ntYe4KnM3xkvlhgp8tZ9TPFjrBzxY8xc8WLZ/xnp/i0E9pcAqu0fNp1WsZT2VTPGV6Rx6GwLxnyZdBXVe9HTQ/dJP1BhpBIcQzH9VGvyztaHVb5HcrN4sU+YDPruOFOHNEpjcYPhlOag0LFSc86uy0iKtkYAdGTUOTcrR2GHrPe2gujyg/4pTzcdPwxHctwynyJikn2IaFRdVk21o00xOM4sqO8u5BYt8jEC8WZbIZaiuNWcjU422lTiEVhEaHKdzDRvhGEqAN83EaqlnuTluLPUvSFc7cnyY44Kl4noy/O2I3779Nk+19ki6Lu6Gm4NmakbD2/tdkkWTrCi7sS+J9nMdxClyFEzQUavgrgAsJs9P2ITrEjqTdWuNzXo/3ar9VC/7Gk3W/CSvMGJ+cC9FPxm/5Y7G6TSblQnxfMsT/kQ3xPekQyvyrfIj/lBB3jjReouETrXAPq4WbMKLIflsx7SB1wPhwXmxv+5PFQe8A+xLUdZ+5ivtfnOyBWajsLdrinxeLZMggvN466FlW4Bt3yBguu/hX5ephA+vjIfsllnaHgiPGyJUnoy5+7Kq24cHh1l+Q51t8hMdDNeEj1FKi0ESUR4oxnFaGikLRPnGw8mxcWygb1OWuglr030Pu+ufiJCtctlro0EQl6iuqa/PI6Cipnm6JK4Jplsj6yuugxTOmBgh+cpxmiHs8TDOkeTxMD4l/2O/641DfqB+Y+JALxei4VbcNKZEi+xdwllTLYjGUVxaRmqqj0UHW7yP07nzHn9zrZ+o2yDS9XexX36+DfwDszggXCmVuZHN0cmVhbQplbmRvYmoKMyAwIG9iago8PC9TdWJ0eXBlL1R5cGUxL1R5cGUvRm9udC9CYXNlRm9udC9IZWx2ZXRpY2EvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtUm9tYW4vRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjUgMCBvYmoKPDwvU3VidHlwZS9UeXBlMS9UeXBlL0ZvbnQvQmFzZUZvbnQvVGltZXMtQm9sZC9FbmNvZGluZy9XaW5BbnNpRW5jb2Rpbmc+PgplbmRvYmoKNiAwIG9iago8PC9Db2xvclNwYWNlL0RldmljZVJHQi9TdWJ0eXBlL0ltYWdlL0hlaWdodCAxNDYvRmlsdGVyL0RDVERlY29kZS9UeXBlL1hPYmplY3QvV2lkdGggNDAwL0JpdHNQZXJDb21wb25lbnQgOC9MZW5ndGggMTMzOTM+PnN0cmVhbQr/2P/gABBKRklGAAEBAAABAAEAAP/bAEMAAwICAwICAwMDAwQDAwQFCAUFBAQFCgcHBggMCgwMCwoLCw0OEhANDhEOCwsQFhARExQVFRUMDxcYFhQYEhQVFP/bAEMBAwQEBQQFCQUFCRQNCw0UFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFP/AABEIAJIBkAMBIgACEQEDEQH/xAAeAAEAAgICAwEAAAAAAAAAAAAACAkHCgMGAgQFAf/EAFwQAAEDAgMEBQQKDQgHBgcAAAECAwQABQYHEQgJEiETMUFRYRQiOHEyQlJ0dXaBs7S1FRYZIzc5YoKFkaGy0zM2V1iUlaKxFyRHcnODxBhDY4SSpSZTVpPU1fD/xAAcAQEAAgMBAQEAAAAAAAAAAAAABQYDBAcCAQj/xAA1EQACAgEBBQUHAwMFAAAAAAAAAQIDBBEFEiExQQYTUWFxMoGRobHB0RQi4SMz8DRDUmKS/9oADAMBAAIRAxEAPwC1OlKUApSukZr5t4ayXwlIxFieemJDb81plPnPSXOxttHtlH9QHMkAE18k1Fat8DJXXO2arrWrfJI7vUfM59uLKnJVx6FMvZxBe29UqtdjCZDiFDsWvUIQdesFXF4GoE7T+3LjjN6P9ibU89hLDUkr1gwnCHpDPsR0rw01CvPBQAE+aBz6zE/hqJsz1/t/Eu+J2ZkuOZLTyX3f4+JNjMjep4/vy3WMHWG14UiE6JfkgzpXgdVcLY79Cg+vvjvizapzfxstxV1zFxApLns2YkxURk+HRs8KdPkrF/DThqPlfZPnItVOzcWhf0619X8T2bnfLpe1E3G4zJ5JCiZTynCSBpr5xPPTlXrxJUmA4XIz7sZZHCVtKKSR3cuzlX5w04aw7xvKCS0O9Ydz+zOwksKtGYGJIIB16JF0eLZ9aCrhPWesVnXL7eZ5w4TdQi9vWzGMMHzk3CIGXgPyXGeAA+KkqqKHDThrLG6cfZkaluBjXrSytP3FtOUO8xyzx+6zCxO1KwHcnNAFTj08MqPZ06QOH1rSkeNS0ttziXmAzNt8pmbCfTxtSI7gcbcSe1KhyI8RWvFw1lPJHaVx/s/3RL+Fr04m3lXE/Z5ersN8a89W/anl7NBCuzXTUVv1ZzXCxFYy+zcJJyxZaPwfL4818y9alR12ZNtHB+0ZHTb06Yexg2gl2ySnQelA5lbC+XSJ05kaBQ56jTzjIqpaE4zW9F8Ci3UW403XbHRoUpSvZgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSldNzVzOsuT2Bbpim/PdHBhI1S0kjjfcPsGkDtUo8vDmTyBNfG1Fas9whO2argtW+CR1/PzP/Dmz7g9d3vbvTzn+JFvtjR++zHQB5o9ykagqUeQHeSAaks3s5cVZ7YwXesSTFSXieCLBZ16CKg6eY0js6hz5lR6ya485M379ndjqdia/PffXjwx4iVEtRGQfNab16gNeZ7SST1mumMqMduRJAJ6BorBSrhKVE8KVD1KUk/JVSysuWTLdj7J3HYuxKtkU97YtbWuL8PJfd9T4N7eRKuTpaIU0jRttSRoFJSNOLTs104vWTXocFc3BTgrxqbji3xZw8FOCubgpwU1Pm4cPBTgrm4KcFNRuHDwU4K5uCnBTUbhw8FOCubgpwU1G4edunS7PPjzoEl2FNjOB1mQwsocaWDqFJUOYII11FWk7E23G3m2IeBscOoj4zQ3wxLidEt3QJHUR7V7TmQOStCRoeVVZ8FcsSQ/b5TMmM85GksLS4080spWhYOoUkjqI011HVWem+VMtYkZtDZlW0KtyfBrk/D/PA2GKVGTYh2pE7QGBFWy9PITjayISiaOSfLGupMlI8TyWByCu4KAqTdWaE1ZFSjyOOZOPZiWyptWjQpSlZDWIabxHbZxVsdfaB9rNjs96+2L7IeUfZYOnovJ/JuHg6Naevp1a669Q8aw+dt/bNA57M5+SzXD+JXVt+d/sT/Tf/QVapQEGdmDeawc1cy0ZZ5mYQkZZ46edEaM1JUsMvyDpowtLiUrZdVr5qVahXVxBRSDmbbf2h71svZEysc2G2wLrcGZ8aII9x4+iKXFEE+YpJ1GnfUI99Vhq34bxXlNji18FuxQ/5ZHclM+a66mOphxleve2pxfPn7NPcKznvTbk9edhBm4SWizJlzbW+62faKV5xHyE6UBibCW8K2sse4ehX/Duz5FvVlmpK40+FbJ7rLoCiklKg7oRqkj5K79kPvTzfMzomXOc+ApGWWJJLyIyJbnStsoeXpwIeZdSHGQokAL1UPOGug1VWb9276EuVvvKR9LfqKO+8w5ak2DK/EIZbbv3lUuCHxoHHI/ChfCe1QSvmOwFxXuqAs7lSmYMZ2RIdQxHaSVuOuKCUoSBqSSeoADXWq5McbzXMTNjMa4YN2Z8tRjNEEqS7e7gw68lwcXD0qW0LbSy3r7Fbq/O1GqU9VZH22s2rxhvdtN3VchbN9xPZbVbn3upWsltsyQQefnNh5PeOLXsr726zytt+XmyJhi5sxUN3bE63rtPfGhU5q6tDI17g0hHLsJV1EmgMEI3jufWz3iS2RdorJ9u3YenL6NN0s7K2XAeslKi64y6pI/7sKQdOZPfY1g/Ftnx9ha1Yjw/OaullukdEuJMZJ4XWljUHvB59R0IOoOhFYx2x8soGbmzLmJh+dHRId+w8ibDKhzblMNqdZUD2HjQAe8FQ7TUZtzJmDLxJs6YgwzLdU8nDl7WmJxHUNx320ucA/5oeV+fQHq7Ue8IzWym2o7hlHgDANnxfIS1HXDZWzIdlyFuR0vKSEtuAHTVXUOoV1uTt47X1mYXOuezQ79j2Bxv9FaLgFBA6zqFK0GnPXQ6dddax9+O1w5/5b6pVVqtARe2NNvLCW13Dm29mC5hfGlub6aXYpD4d42tQkvMuaJ40BSgCCAUkjUaEE9I3hm3NizY/vOCYmGrDZry3fWJTr6rqHiWy0poAJ6NaevpD169lRnxxa4uUW+Sw6cKNpit3mdFdmRImgSlUuMUSdU/lcSnTr2q1A6q5t+L/OrKT3lcv349AZA/7b22d/Vn/wDZ7h/ErLmy3tL7RmaObDFizLyX+0jC64jzy7t9jpbPC6keYjidWU+cezrqZ1KAhPtX7c2LMgtqzLvK2z2GzXC0YlYtzsiZODvTtGROdjq4OFYToEtgjUHmTrqOVTYqpXeTfjI8i/edi+uJVW1UAqE+z3tzYszf2z8wcnLlYbNCseHJF2Zjz4od8pdESWGEcfEsp1IOp0A59WlTYqpXYe/GvZ3+/MS/WaaAtqr0LzeIOHbRNutzlswLbCZXIkypCwhtltCeJS1KPUAATrXv1Cfe6Zhy8D7I0m3QnlMuYmvEa0OlBAV0PC5IWPUfJwk6ditO2gMUXzeW5u56Y3uVh2asqhiK1wFcLl5u8Zx1S06nRwpDjbccK0PCHFKJA10B1A/bJvK838isa22x7SuVCcPWuerhbvNojuNFtOvNwArcbfCe0NqSoDnoToDJrd35XQMrNkTL1qJGbal3y3t36a+kDifclJDqVK9Tam0DuCB261+7xDLKBmhshZhsy46HpNkgLv0J5SdVMOxUl1SknsJbDqD4LVQEhLJeoGJLPBu1rlsz7bNZRJjSo6gpt5taQpK0ntBBB1quPN7eSZy4d2mMW5UYBy2s2LpNqmuR4jLceU9LfQhvjUopQ4AdBqeQHIVlTdFZgy8bbIsa3zHVPLw1eZVnZU4dVdFwtyED1DygpGvUE6dQFRsyb/HR4p9+3T6CqgO4XreRbS2WEcXvMLZ0XAwy0QJEhMOdCSjmNNX19IhHcOJPM1NrZj2nMI7VeXSMU4VW7HUy55PcLXK0EiC/prwK05KBHNKhyI7iCBlS52yJe7bKt0+M1Mgy2lsPx30hSHW1ApUlQPWCCQRVUe5+eVYto7OTDdrcUvDqYalI87jBLMstsniHIngcXz7aAtopSlAKql289oJWbGZa8NWqTxYWw44phvoz5smV1Ou+IHNCevkFEezqd+15m+rJjI693aI90F5mgW22kdYfcB84eKEBa/Wkd9U3Kc1JOupNQO0r2kqo+86Z2P2apyln2Llwj69X9vifteE1bX2McR5wfU6jh06igBXF+0pr8JJr7+HsFX3MR+1WLDVolXq7vyHyiPFRxK04WvOJ9qkdqlaADmSKgoJt8DpeRNRrbk9EdJ4PCvu4PwBiLMG6i24asc++zjzLMCOp0pHerQeaPE6CrA8iN2TbLc3HuuaM83OXyX9gbY6UR0fkuvDRSz4I4QNPZKFTZwpgyxYFtDdrw9Z4VltyPYxoLCWUa9+iRzPieZqapwJz4zehzvO7TY9DcMZb78eS/krCy/3Y+ZuJ0IfxFMtWD46utp9zyqSB38Dfmf4xWfsLbq3AVvbQq/4qv16eT1iGlqG0r80pcV/iqblKk4YVMOmpT7+0G0LnwnuryWnz5/MjVbd3fkVBRo9hSTcTp7KTdZQP+BxIr3vufuQf/wBBf+8T/wCPUh6Vn7ir/ivgRr2lmt699L/0/wAkWLzu2slbohYjW27Wgq10VCua1FPq6UL/AG61ijGG6htTqFrwrjuZFWOaGLxDQ8D4Fxso09fCan9SscsWmXOJs1bZ2hU9Y3N+vH6lOeZOwHnBl0h2Qiwt4ogNgkybA75QoAf+EQlwnTuSR41HmVBegyXY8lhyO+2rhcadSUqQodhB6j662Eqxpmzs84AzthLZxXh6NMlFPC3cWk9FMa5cuF1PnaD3JJT3g1pWbPXOt/EsmJ2qnFqOXDVeK4fL+UUacHhTg8Kk7tcbGy9nAwLrbb8i74ducgxoyJaejlNOBJWEKI8xeqUnmOEk8uHq1jQpsoUUqSUqSdCDyIPdULZCVUt2a4nQcXIpzKldRLVM7dk5mld8lcx7Ni6zHWTAd1cYKtEyWTycaV4KSSOrkdD1gVeHgjGNszBwjaMSWd/ym2XOOiSw528Kh1HuIOoI7CCKoO4PCrHN13m+q44fv+XE57Vy2qNztqVHn0C1APIA7krKVet01I4F27Pu3yZU+0+z1bQsuC/dDn5r+H9yelKUqwnLCqvfnf7E/wBN/wDQV2r7rtjj+rDiD+93/wD9fXVd+d/sT/Tf/QVapQFR8LJ/PDeT59YcxZmdhCRl/ljY+EJiS2HGAtjjC1tMpd0W646QEqd0CQEj3ISZM73VsN7GlwSkBKReYAAA6vPVU16hVvePQ3uXwzB/fVQEVNmHbTz/AMrsgcKYdwps93fF2GLbHdTFvzFrnuNSUF5xalBbbZQQFKUnUH2vrr4OU9kx/vZ8+W75jy62u0YIwh0XlNot6yhTcd1ZV0UdslSit0taLeUdAANNdEoqwndu+hLlb7ykfS36gu+79z13mZWSbflzjRziVz4WGoUxzme4CPIST3htH5fMCR++IYbjbIVvZZbS003iSElCEJASkBmRoAOweFZu2A/Q3yn+Bk/vrrqu82y3mZkbHONG7e0p+dZize22kp4iUMOAvHw0ZU6rl7nTtNfD3VeblszG2TcP2NqU2u+YTW7a58biHGhJcW4wvh6+FTakgHtUhY7KAk3mz+CzGXwNN+YXVdW46/mtm379tvzcippbaGacDJ/ZizDv06SiO87aX7fBSo6KclvtqaZSkdp4lcR06kpUeoGo37mrLmZhbZxvmJprKmRia9Lciaj+UjsIDQWP+Z0w/NoCNG13mlMyW3qSsawMOv4tmWlqG63ZozpbcklVuCOEKCFkaBfFySer5azNJ3tWY05hbFs2Zb4i4ODhYU5cJL6Qvs1bTCSVDwCgfGus4+/Ha4c/8t9Uqq1WgK09iTZWzTzC2kbhtIZ425yx3Za3H7daJbJafU8proUqLKiVNNNNeahC/O1CT7XVXQd+L/OrKT3lcv349W1VUrvxf51ZSe8rl+/HoDIH/ZQ29f6wOH/71l//AINSc2O8rs88sbdidrOzHkDHMqY6wq2OQZTr4jISF9KD0jLWnEVI6ters7ZHUoCpXeTfjI8i/edi+uJVW1VUrvJvxkeRfvOxfXEqraqAVUrsPfjXs7/fmJfrNNW1VUrsPfjXs7/fmJfrNNAW1VXVvtPwB4F+Mw+iv1YrUKt7flxLx5sjS7hBaU89he7Rry4htPEos8Lkdz5EiRxnuCNeygM/7Jvos5N/EyzfQWabWXos5yfEy8/QXqxzu5c3LbmvslYFTElNuXHDsFuwz4wUCthcdPRt8QHUFNJbUD2g+Brk3i+advyu2RMfqlSUNTb7BXYYTJVop9ySOjWlPfo0XFHwSaAwFuS/wB46+Mx+isVFfG2ZWL8o96Fj3E2BsHyceYjjXKYhixxGHnnHkrjcCyEtArPCklXIdnOp07pHLmZgPZEhzpzKmXMTXeTemkrTooMlLbDZ9ShH4x3hYPbUacm/x0eKfft0+gqoD4+0NvMtoiFhb7W7nlevKGZfW3GGbnc4UuNJU3oErMcyAhKSONOq9Dw6jqOhEyt3fsaK2T8ubjLvcyLcsZ4lLT852CvpGIzKAromG1+29mpSlDQEkAahAUeHeg5AjO3ZjulxgRumxDg8qvcMpT562Up0lNjwLWq9BzKmkCvDdebQf+m/Zpt9ruEvp8S4OUmzTeNeq3GAnWK6fAtjg1PMqZWaAmDSlKArU3nuYi7vmNh3BzDmsWzwjMfSD/3755AjtIbQgj/iGoU6isp7VWK14w2iswLipZcCbs7EQrvQx94T8mjYrFBOtUzJl3l0peZ+hNk0LFwKal4LX1fF/NnmV1ZTuto7H+ivFsjomxJN64FO6DjKegbITr3ak6D11WjxVYbup72l20ZiWk6BTL8KUnvPGl1J/VwJ/XWxgNLIXvIntOnLZc9OjX1RPqlKVaziIpSlAKUpQClKUApSlAQg3sjbRyKwq4V6PJxI2lLfekxpHEfk0T+uqxLfegUpYmkqbACUPAaqb06tfdJ05adY5adWhsm3tlzS3lngW3cuN+7uyB6m2Sk/OiqwKgMzR2vU6h2fbhhRkn1f1O1raUjhOoUhQ4krTzCh3j/+8DWXNkrMBeWe0Lgu7FzgivTU2+Xz83oX/vSie8JKgv1pFYLtF3ML7w8C5EWdSkdaD7tPjy5jqI5dYBHYE8bDiHGnCCNFtuoJHqUP86i+NUlJF00hm0zpn1TT960NgClddy9xMnGmAsNYgT1XW2xpw5afyjSV9X51diq5J6rVH59lFwk4y5oh9vA9iK+bZBwGLNiW34d+1zy/pfLmVudN5R5Ppw8PVp0B117xUwaUr6eRWBttPZ1uO1HkfJwLarvFskt6dHliXMbUtADaiSNE89TrWeaUBinZcyemZBZC4RwBcLgxdZlkYcZcmRkFLbpU845qArmPZ6Vi3b02Kk7YeE8OMW66xbBiSxy1rYuEtpTiFRnEaOtEJ581JaUD2cJGnOpUUoDouTmEr/hLKTDeGcY3ONiG+W6AmBMuDKD0csIHAlZCuZKkBPFr1niqEGY262xTgrMaZjTZxzLcy5kzCortEl59lloFXEW0PNBRUzrp97WhQGg5nkBYzSgKz4G7EzfzmxVbZ+0LnOcSWiAsKTbLRJkSStPalCnUNoYKgOaktqJ/aLGMK4VtWCMOWzD9igNWyzWyOiJEhsDRDTSBolI+QdZ5nrNfYpQEPsR7EV8ve3rbM/kYlgNWeJ0XFZ1Mr8oVwQzH5K9j1nX1VMGvQu16t9giKl3OfGt0UEJL8t5LSAfFSiBXVbfnnlvdpSI0HMDC02Sv2LMe9RlrPqAXqaA7zUM9v7YUvu2Jd8GTLNie3YeTYWJTTiZzDjhd6VTZBHD1adGevvqZKFpcQFJIUk8wQddRXnQFav3PXan/AK12IP77un8asp7M+yBnvlLm9asS45z8u2PMORmn0P2OVc577byltKShRS64UHhUQrmOzlU16UBBfbe3fmLdqHO3D2PsNY3g4UctFnj29rpW3enQ81JfeDqFoI4dOmToQdQU61j37nrtT/1rsQf33dP41WVUoCL+x1s45sZE3LFD+ZOblxzNYuTUdEJqdOlyREUgrK1Dp1q04uJI5aa8POo24x3XWaz+emOcxMFZxs4LlYivE+4NuWsyoslpmTIU90SnGlJJ606gHQlNWZUoCtX7nrtT/wBa7EH993T+NUy9nvKLEeXuR0XBOZGKHMyLqrypufc7k67J8rZdWr72svFSlJCFcGhJGnLqrL9KArZxTuucf5WY5uGI9m/Nh3BDE4+fablJkMpbTqSGy80lfTIBJ4Q42SO1SjzrxwzuvMx81sc22/7R2bS8aQ7erVNotsqQ+l1GupbDrqW+hQrQcQbb1PPQg+dVlFKA9K0WqHYbVDtlujNQYENlEeNGYSEoabQkJQhI7AAAAO6ogYI2Fb7hTbru+fTuJrc/aZr8t1NoQwsPp6aOWhqr2PInWpmUoDieaRIaW24hLjaxwqQoahQPWCO2oVbK2wTiTZW2iMTYssWLre/l/ehIYOHyy4H22CsuRhxexK2jonXlqkq79Km1SgFKUoCgjEd1N6xBc7iTqZcp1/UjTXiUVa/tr5nFXJLYXClPMO/yjS1Nq0Oo1HL/ADFeuV91UbQ/SKaSSXI8ye+pbbszGaLFn/Jsjrmjd9tTzLSdet5opeH+BD1REJ1rtuUWPXcr8zsMYqZClfYqe1JcQnrW0D98T+cgqT8tZ6Z93ZGXgRu0aP1WJZT1knp69PmXx0r1YM6Pc4UeZFdRIiyG0utOoOqVoUNQR4EGvaq5HABSlKAUpSgFKUoBSlKArD3s+Kkz8xcD4bS4FG22x6cpI9qZDgTz+SMDp2Dn21AsprOW2XmGjM/aRxpdmHA5BjyvsdFUk6gtxx0XED2hSkqV+dWEiKrN09+yTR2LZ2O6MOqD56fXievX2rJdw2kQ5J+8k/enD1tK7v8AdPd2HmO0H5RTXGRpWFpSWjJGMnXJSjzL0NkSU7M2a8v1PpWhxu3BgpcGhAbWpA/YkfJWYqwRsONPMbKWXKX+azAWoaq180vOFP8AhIrO9Wer+3FeSOM5r1yrX/2f1KgN95+FPLX4GkfP1WtVlO+8/Cnlr8DSPn6rWrKaRtUUpSgFRU3o/oK5mfoz6ziVKuoqb0f0FczP0Z9ZxKAoCq9PdD+hvbfhmd++mqLKvT3Q/ob234ZnfvpoCatV47wXeVuZH3OXlzlg5Hl42aHDc706hLrNrJAIabSdUuPaHU8QKUdRBVqEyu2s87Rs8bPuMsdI4FXCBE6O3tucwuW6oNM6jtAWtKiPcpPVWuFc7nLvdylXC4SXZk6W6t9+Q8oqW64olSlKJ6ySSSaA+1jzMjFWaN9cvOL8Q3LEd0XrrJuMhTygDz4U8R81PgNAOwV1qp5bujd72/aagT8dY9emRsExJBhw4MNfRu3J5IBcJX1paRqkap5qUSARwHWwPFO632csR2BdtjYIdw+/wcLVxtl0k+UNeP31xaVH/fSqgKcchNrzNTZwujD+DsUym7ahQU7Y5qy/b3x2gsqOiSfdI4VflCrxtkDa4wztcZd/Zu1JFsxBA4GbzZFr4lxHSOSkn27S9FFKtOwg6EEVRntWbON42Wc5Lrge6yPL46EJl265BHAJsRevA5w6nhOqVJUOeikK0JGhPYNhjP6Vs7bSGFb+ZSo9hnSE2u9NlWiFw3lBKlqH/hq4XR4t6dpoDYnqgHej+nVmZ+jPqyJV/wBVAO9H9OrMz9GfVkSgMf7FHpb5Q/GaD86mtj6tcHYo9LfKH4zQfnU1sfUBH/b89DfNj4GV++itdetijb89DfNj4GV++itdegLqdyp6LOKfjnK+gwa+rvkvRHh/GaF8zIr5W5U9FnFPxzlfQYNfV3yXojw/jNC+ZkUBSDWwnu3fQlyt95SPpb9a9lbCe7d9CXK33lI+lv0BGrfefgsy0+GZPzAqoGrft95+CzLT4Zk/MCqgaA/QSk6g6HwrKWWm1Hm1k/Nak4TzBvtrDZ4hFMtT0VR/KYc4m1fKk1aJkXutsjMxMisvcT3WHfRd77hu33KW7HuhSnpnorbiylPCQBxKOg5gVHjbY3V/+gvBE7H2W94n37DltT0tztd14FS4rXa+hxCUhxCdfOHCFJHPVQB0AkvsN70G357XaDgTMhiHh7G0jRuDcmDwQ7mvsb4T/JPHsGpSo8hoSEmwGtVyPIcivtvMuKadbUFoWg6KSRzBB7DWwTu9tpB/aU2c7Td7tI6fFNmcNovCyfOdebSCh4/8RtSFE6AcXGB1UBV7nbYFYTzjxvZ1JKBCvUxlA5c0B5fCfURoeyuklVSe3jWBF4P2krjcUo4YmIYbFxbI6gsJ6JweviaKvz6i6TVOuhuWSj5nfcHIWRi12rql9DyKq/Cda8CvurxJNY9Da3i3Hd4ZzozLyNj2CXI6S94UKbe6lR85UY6mOr1cILf/ACvGpU1SPsoZ9PbPmcNtvzilqsUr/UbuwjnxxlkarA7VIUErHaeEp1Gpq623T412gx5sN9uVEktpeZfaVxIcQoapUk9oIIOtWfDt7yvR80cd2/g/pMtziv2z4r16r4nt0pSt4rQpSlAKUpQCsTbUObjeSWSOJcTpdDdySwYttTy1VLd81sgdvCSVke5Qqss1VbvJs+hmBmPHwJapAcsmGVEylNnUOzzyX6w2PM8FFzr5Vq5Nvc1t9ehM7IwXn5ca2v2ri/RfnkQvc1WoqUdVE6knmSa4ymvYKa8CnWqxqdkcT1imvApr2Cmu25PYBdzPzVwphVtKiLtcWYzpT1oaKvvq/wA1AUr5K9ri9DWsahFzlyXEuy2dsNqwjkTl9Z3EdG9FsUNLyNNNHSykuf4iqsjV4IQlptKEJCUJGgSBoAK86tqWiSOHTk5zc31epUBvvPwp5a/A0j5+q1qsp33n4U8tfgaR8/Va1fTwbVFKUoBUVN6P6CuZn6M+s4lSrqKm9H9BXMz9GfWcSgKAqvT3Q/ob234Znfvpqiyr090P6G9t+GZ376aA6Jvq8UPW7IHBtjbUUN3PEIfdI9slmO5on1cTiT+aPlpnq2jfi/zWyk9+3L5uPVS9AbF+wnhCPgnZAyngRkJQmRYY9zVw9q5SfKVH16ums81inZN9FnJv4mWb6CzWVqAqy34GEWDByqxQhtKZSXZ1tec7VoIacbHqBDv/AKjVUlW/b7z8FmWnwzJ+YFVA0Bs0bP2KXccZEZc4hkudLJuuHLdNeXrqS45GbUvXx4iapB3o/p1Zmfoz6siVcnsU+iPlB8WYPzKaps3o/p1Zmfoz6siUBj/Yo9LfKH4zQfnU1sfVrg7FHpb5Q/GaD86mtj6gI/7fnob5sfAyv30Vrr1sUbfnob5sfAyv30Vrr0BdTuVPRZxT8c5X0GDX1d8l6I8P4zQvmZFfK3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrIOKMOwsX4Zu9iuLfS2+6RHYUls+2bcQULH6lGsfbJvos5N/EyzfQWaytQGrBcIK7bPkxHSlTjDqmlFPUSkkHTw5VZbuQ8XyI+O8zMLFalRZdti3MI9qlbTqmyfAkPj18I7qryzSaQzmbi5ptCW20XeWlCEjQJAeXoB3DSprblT0psU/EyV9Og0BODeaZTKxjk/BxhCYLlwwvI4nikecYjxCXPXwrDSvAcRqq0nvrYIxDYYOKbDcbNdI6ZduuEdyLJYX1ONrSUqSfWCaozz5yhuWReaV7wjcQtYiO8USSpOgkxlc2nB6xyOnUoKHZUFn1aSVi6nSuzGcp0yxJPjHivR/z9ToRVXiVV414lVRWhdnI8tTVh+7j2r0BuNlLiuYEqB/+H5jyuvXmYhPf1lHyp9yKrsKq/WZDkZ5DzTi2nW1BSHEEhSVA8iD2HXtFbFNjplvRIvPxK8+h02e5+D8TYjpUMNiHbfYzfixcEY3lNxsbsI4Ys1eiUXVAH6g8ANSn23WO0CZ9WauyNsd6Jx7KxbcO11WrRr5+aFKUrIagpSsc54524fyFwJKxLf3Cvh+9xILagHZjx9i2jX9ZPUBqefVXmUlFb0uRkrrndNV1rWT5Ix/tl7SkfZ+y3dRAeQrGN3Qpi1R+stctFyFDuQDy161cI0I4tKc5Lzsp9x59xbzziitbjiipSlE8yT2nt1Nd3zezUv2dWO7hirEMjpZkk8LbIJ6OMyD5jTY7Ep1+Ukk6kknpJGtVbJyHfPVclyO1bI2VHZmPuvjOXN/b3HrlOlcZTXslNcak1rJkw4nrkVODda5SLvmY16zAlM/6jYo5hQ3D2ynk6K0/3WuIH/iioYWiyzcQ3eFardHXMuM15EePHbGqnXVq4UpHiSQKvA2c8nIuRGUNiwkz0bkthvpp8hvqflL5ur8Rr5o/JSmpLCq7yzefJFP7R5axsXuU/wB0+Hu6/gyfSlKsRykqA33n4U8tfgaR8/Va1WU77z8KeWvwNI+fqtagNqilKUAqKm9H9BXMz9GfWcSpV1FTej+grmZ+jPrOJQFAVXp7of0N7b8Mzv301RZV6e6H9De2/DM799NAYZ34UZxWDcp5ARqyifcG1K7lKbYIH+FX6qqSq7DfLYHexDsw2m/x2uNWH7+w8+vT2DDzbjJP/wBxTAqk+gNlLZN9FnJv4mWb6CzWVqjPu48xouZOx5l88w8lyTZon2Clt8WqmXIx6NKT3atBpYHctNSYoCtXfefgsy0+GZPzAqoGrPN9vmPEn4qy2wNGeC5VtjSrrNbSrUJ6ZTbbIPcdGXT6lDv51kR47kp9tlltTrrighCEDVSieQAHaaA2Odi1tTWyVlClSSlX2sQFaHuLKSD+o61TXvR/TqzM/Rn1ZEq9HKTCCsvsqcGYWWAFWOywrYQDxAFlhDfX2+x66o13p0N2Nty5huOJ0RIbtrrZ70/Y6Mj/ADQoUBjjYo9LfKH4zQfnU1sfVrd7GsxmDtYZQvPuBpsYot6eI9QKn0JH7SBWyJQEf9vz0N82PgZX76K1162F94rd27JsW5pyHdOFy3tRhqrTznZDTQ/ascv8q16KAup3Knos4p+Ocr6DBr6u+S9EeH8ZoXzMivS3L8B2HspX11waIlYtlvNnvSIsRH+aFV7u+S9EeH8ZoXzMigKQa2E9276EuVvvKR9LfrXsrYT3bvoS5W+8pH0t+gI1b7z8FmWnwzJ+YFVA1b9vvPwWZafDMn5gVUDQGylsm+izk38TLN9BZrK1Yp2TfRZyb+Jlm+gs12TOHMaDlFlZivGdycQ3DsduemnjOnGpKTwIHipXCkDtKhQGtbmPMRcsw8US2goNSLpKdSFciAp5RAPjzqb+5VZcVtP4rdCSWk4OkoK+wEzYRA/Yf1VAB11ch1bjq1OOLPEpajqST1kmrTNyFl490+ZuOnmuGPwxrLFd09mrm8+nw0Hk58eLwoC1iou7dOy7/p8wAm72KOlWNrE2pcMDQGazrquOT39aka+21HLjJqUVKxzgrIuMjZxsizFtjdU+KNd19pyM8408hTTqFFK21p0UlQPMEdhrj1FWW7eGw6vFqp+ZOXsLivYBeu9kjp5zABzfZA63fdI9v1jztQqs5WoJB1BHLSq1bTKmW7I69g59WfUrK+fVeDPIqrx4q8eKvEqrFob28czEl2I+2+w6tl9pQWhxtRSpCgdQQew689RViWyfvJG+hh4UzcklK06NRcU8OoV3CUB1Hs6QdfLiA5qNcpVXjxVsVWSqlrEjczDpzq9y1ej6r0Nie33GLdoLEyFJamQ5CA40+wsLbcSeYUlQ5EEdor26o82dtqnMvIi4JjYXnG52Qq437FcNXYhB5FQ5joTqR5ySka6cWoGlSxzF3nFzueEI0XCOG0WTEL7X+tzJbyZLcRfaGRwgOH8pQ0HuVddSv66pR1nwZSH2azZWqFC3ovry09f41JZbQO0xhLZ7sJkXiR5be32yYVkjKHTvnmOI+4RqPZHuOmp5VUtnPnPibPPGL2IMSy+kcOqY0NokMRG9fYNp7B3nrJ5kk113EeILni69S7veZ79zuktZcflSVla1nxJ8OWnUByHKvlEd9QWTmSyHpyj4HS9kbBp2VHe9qx839l4fVnrlNcZTXslNeBTWnqT7iespOlcZTXslNS92K9il7NmZFxrjOMuPgtlfHFhLHCq6KB/WGQRzPtuodpGequV0t2BFZuVTg0u656JfPyRkjdybLS4QazZxPE4XXEKTYIjydCEEaKlEeI1SjXsKlac0mrBa4WGG4rKGWUJbaQkJShA0SkDqAHdXNVtpqjTBQicOz82zaF7vs68l4LwFKUrMR5UBvvPwp5a/A0j5+q1qt93rOy7mjn9mDga4YAwjJxJDt9reYkusPsthtZd4gD0i09ndUFvub20j/RbcP7bE/jUBKr7uLfP6JLf/AH4v+BT7uLfP6JLf/fi/4FRV+5vbSP8ARbcP7bE/jU+5vbSP9Ftw/tsT+NQFgmynvUrptIZ+YWy6kZdw7EzevKuKe1dVvKa6GK8+PMLSddei4esdevhWZd6P6CuZn6M+s4lQb2AtifOzKLa2wJizF+AZllw9b/L/ACmc7JjrS30kCQ0jkhwk6rWkch21YTt+5b4kzc2SMd4TwjanL1iG4eQeSwWlpQp3o58d1fNZAGiEKPMjqoDXdq9PdD+hvbfhmd++mqwPub20j/RbcP7bE/jVbbu2spcW5KbMkHDONbK7Yb43dJb6obziFqCFqBSrVClDnp30BnPOXK+2Z05V4owPeOUC+QXIinAniLSyNW3QPdIWErHikVrb5p5Z3/JzMG+YOxPDVBvVokKjvtkHhXp7FxBPskLSQpJ7UkHtrZ8qM+2LsLYM2ubM1ImOHD+NILJbgYgjNBauHrDT6OXSt6nUDUFJJ4SNSCBTzsf7bGMNkDEM120Rmr/hm5FKrhYJbpbbdUnkHG1gHo3NOXFoQR1pOg0mrijfe2/7X3BhzK6SL4tGiDdLmkxmld54EcTg8PN17xUTc092Pn/lnPdQzg9WL7cFEN3DDbokpc/5XJ1Pyo08TWIbpsw5wWOzz7rdMq8Z2u2QGVSJUydYJTDTLafZKUpbYAA6yewc+ygOvZrZo4izozAvWM8VTjcL5dXumfd00SkABKUIT7VCUhKUjsAFST3ZWzLMz42g7Xfp0NasH4Pfauk99SfMdkJPFGYHeVLSFEe4QrXTUaw+q3zdV7Y2X72C7RkvOtUDBeKGVkwpDOoYvrqvZLUpRJEk6AEKOigEhGgAQALLKqS30uRsuHivCebECKpdumxhY7m6gcmn2ypbC1f76FLTr1DoR3jW22uu4/wDYM0sG3bCuKLY1drDdGTHlRHtdFpPPUEc0qBAIUCCCAQQQKA1grfPk2qdHmxHlxpcdxLzLzZ4VNrSQUqB7CDodatHyx32Rg4XhxMeZfP3K+MNBD1ys01DbcpQ9uWVI+9k9ZAURr1ADkMf7RG55zAwjd5U/KiSxjXD61FTVtmSG41xjp9ySspbdA90Ckn3PfFK7bG2e1klGPIygxq4sdsOxyJKP/U0hSf20BmjbZ3j192ssPRMJW3D6cI4PZkJlvx1SzIkzXU68HSKCUpShPFrwAHzgCVHQAQ7ixXp0pqPHaW/IdUG22mklSlqJ0AAHWSeWgrP+B937tB49lNswcrr3bkq63r42LchA7z05QfkAJ8DVk+xJuurVkHfIWN8w5kPFONI33yDBjIKoNtc/wDmAqALro7FEAJPMAkBQAkVsWZKv5AbM+CcHz2w3eGYqpdyA6xKfWp1xBPaUFfBr3IFYG3yXojw/jNC+ZkVOqoj7zjJ3GWeOzjGw5gaxvYhvSb9GlmIy42hQaS28FK1WpI5FSe3toCg+thPdu+hLlb7ykfS36qA+5vbSP8ARbcP7bE/jVc9sPYBxBlbsr4Awrim2uWe/wBtivNyoTi0qU0TJdWBqkkHzVJPInroCJe+8/BZlp8MyfmBVQNXfb1nILH+fuX2BbfgDDb+JJlvubz8lph5pvo0Ka4QT0ik9vdVav3N7aR/otuH9tifxqAkDllvib1llldhPB0fLKBOGH7NEtDU127rT0vQMoaDikBrlrwa6BXhr21H/aj2+8ztqqG3aL89DsWFWnQ8mx2ZCkNOrHsVPKUpSnCOwEhIPMJB51+p3bm0itQSMrZ4JPWqdDA+erKWWe58zwxdMa+2j7C4Eg8Q6VcyaiZICe9DccrSo+CnE+ugIbYFwRfMysXWrC+Grc9db7dHxHiQ2BqpxZ/YABqSToAASdADWxRsoZAQtmXIvDmBoy25E2M2ZNzmNg6SZjminVjt4ddEp158KE611XZR2HMvdky2rdsbLl6xXJa6KZiO4IHTrTrqUNJHJpH5KdSdBxKVoNJF0ApSlAKhptb7vu0ZxuzMV4HMewY0Xq5IjL82JcVdpVp/Jun3Y5KPshzKhMulY51xsjuyRtY2VbiWKyl6P/OZr343wBiPLfEj9gxPZpdmvDJ0VFkt6KI7FJPUtJ7FJ1B7zXot4YurjoaXCXHUocQ8q0YBHrXprV+GY2VuF82LA7ZsVWhm6wljzePVLjR70LSQpB8QR8tQpzN3X7yVPSsAYpStPMpt19ToQO4PNj/NHy9tQt2JbDjWtUdF2dt3DyFu5cu7l6ar49PeveV2sYVcUgLflssni4VNJ1WsDXrGg4T3+yr6DFitsbrQ7NVqRxPK4EkacvNTzB/OI8KyxmDs05m5Xl1V/wAH3FmIgnWdFb8pjad5cb4kp79FaHwrGVQ052RekloX7HoxbY79UlNeKeq+R5qeUW+jGjbWvF0TaQhAOgGvCOQOg6+2vClK1ufMlElFaJCvwjWv2uy4My0xZmHJEfDWHbnfHOLhJhRlOIQfylAaJHidBX1JyeiPM5xrjvTei8zqxTpXPbbRMvlwjwLdEfnTpCw2zGjNlxxxR6glI5k+AqZGVO7SxfiFTMvHN0j4WgnmuFFIlSz4aj72j16q9VTfye2csBZGxAnC9jbbnqRwO3WV9+mOjt1cI5A8vNQEp8KlacC2zjL9qKZtHtRg4qcaH3kvLl8fxqRM2X93apl6JibNVhCtNHY2GQriGuvIyVDkR29GNfyj1pqfseO1EYbZZbQ0y2kIQ2gAJSAOQA7B4Vz0qx00QojuwRybP2jkbSt7y+Xoui9BSlKzkYKUpQClKUApSlAKUpQClKUApSlAK43G0PtqQtIWhQKSlQ1BFclKAqf3hO7HXbjdMzMnrYXIhK5V3wpFTzZGmqnoiR1p6yWRzHtBp5ohvsh7HuM9q/HCYVjC7Rh2CtKrniR1tRZiDrCUdXG8exAI7yQOdbFFfKsOGrRhWI7Estsh2mK6+5JWzBYSyhbriipxZCQNVKUSSesmgPHClg+1bDNqs/2Qm3XyCM3F8uuTvSyZHAkJ6R1eg4lnTUntPOvr0pQClKUApSlAKUpQClKUApSlAKUpQClKUApSlAKUpQClKUArGebWWWD8Q4fnz7rhOx3OcACJMy3Muug6jnxKSTSlaeV7BObG/wBUirPPOxW20vSPIbfFh6ON6eTsJb08zwFY+wDGZmXwIkNIfRwK81xIUOrxpSqjL2zvVf8AZ934LPNmnKTA0y0KmSMGYefltrHA+5amFOJ5HqUUaipJxI7UOK2yw2hhpCdEttpCUj1AUpVowvZOMdo/76PapSlSRUBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoBSlKAUpSgFKUoD//ZCmVuZHN0cmVhbQplbmRvYmoKMSAwIG9iago8PC9Db250ZW50cyAyIDAgUi9UeXBlL1BhZ2UvUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldL0ZvbnQ8PC9GMSAzIDAgUi9GMiA0IDAgUi9GMyA1IDAgUj4+L1hPYmplY3Q8PC9pbWcwIDYgMCBSPj4+Pi9QYXJlbnQgNyAwIFIvTWVkaWFCb3hbMCAwIDU5NS4wMSA4NDEuOTldPj4KZW5kb2JqCjcgMCBvYmoKPDwvS2lkc1sxIDAgUl0vVHlwZS9QYWdlcy9Db3VudCAxL0lUWFQoMi4xLjcpPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDcgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvTW9kRGF0ZShEOjIwMjIwMjI0MTg1NjQyWikvQ3JlYXRpb25EYXRlKEQ6MjAyMjAyMjQxODU2NDJaKS9Qcm9kdWNlcihpVGV4dCAyLjEuNyBieSAxVDNYVCk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxNTQzMiAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDE2MTcgMDAwMDAgbiAKMDAwMDAwMTcwNSAwMDAwMCBuIAowMDAwMDAxNzk1IDAwMDAwIG4gCjAwMDAwMDE4ODQgMDAwMDAgbiAKMDAwMDAxNTYzMSAwMDAwMCBuIAowMDAwMDE1Njk0IDAwMDAwIG4gCjAwMDAwMTU3MzkgMDAwMDAgbiAKdHJhaWxlcgo8PC9JbmZvIDkgMCBSL0lEIFs8MTRmMjhmN2Q5NDdhOTM0MzNiN2QzZWNiZWZlNDRiNjc+PDZhMDJkZTJjODNiZGQyMjViODE4NjE2OTE5NTdiZmI3Pl0vUm9vdCA4IDAgUi9TaXplIDEwPj4Kc3RhcnR4cmVmCjE1ODQ5CiUlRU9GCg==","contentType":"application/pdf","fileName":"order-162.pdf"},"messages":["PDF created"],"total":1}}}}}},"404":{"description":"Order PDF by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"0"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:37:05 GMT"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"c5d4a18d-97a2-4285-8489-caf58535cb4e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [395] not found"},"example":["Order with id [395] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Order PDF by lookup key - 404":{"value":{"error":{"code":15001,"messages":["Order with id [395] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/order-update-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/orders/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update order headers details. This request does not support updating orderitems. An order `address` can be updated using the order address endpoints.

Orders are referenced by a lookupKey / lookupId combination

| **lookupKeys** |
| --- |
| `id` |
| `sourceId` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1600"},"description":"The `id` or `externalId` of the order"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"exportDate":{"type":"string","example":"2022-02-24 19:38:19"},"exportMessage":{"type":"string","example":"ERP order id: 50001"},"exportStatus":{"type":"string","example":"EXPORTED"},"externalId":{"type":"string","example":"50001"},"status":{"type":"string","example":"ARCHIVED"}}},"examples":{"Order by lookup key":{"value":{"exportDate":"2022-02-24 19:38:19","exportMessage":"ERP order id: 50001","exportStatus":"EXPORTED","externalId":"50001","status":"ARCHIVED"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Order - 200 / Update Order postage data - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"1905"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 15:47:51 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fcbdb98f-f9ef-4b57-a63b-0e5a60b87d09"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"SV"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":"sander123@propel.us"},"firstName":{"type":"string","example":"Sander"},"fullName":{"type":"string","example":"Sander Vleugelhof"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14711},"lastName":{"type":"string","example":"Vleugelhof"},"login":{"type":"string","example":"sander123@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"undefined"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-02-24T14:14:55"},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":""},"externalId":{"type":"string","example":"50001"},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"id":{"type":"number","example":162},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81752},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":5},"postageNet":{"type":"number","example":6.05},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81753},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"siteId":{"type":"number","example":100037},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"ARCHIVED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"21":{"type":"number","example":3.15}}},"totalGross":{"type":"number","example":20},"totalNet":{"type":"number","example":24.2}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14711}}},"messages":{"type":"array","items":{"type":"string","example":"Updated"},"example":["Updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Order - 200":{"value":{"data":{"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"50001","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"ARCHIVED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},"messages":["Updated"],"total":1}},"Update Order postage data - 200":{"value":{"data":{"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"50001","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"ARCHIVED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},"messages":["Updated"],"total":1}}}}}},"400":{"description":"Update Order - 400 (invalide fieldname)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Thu, 24 Feb 2022 18:46:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"a7b7ade4-1d73-41e5-8cee-d359132a1f58"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [Date] is not permitted"},"example":["#: extraneous key [Date] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Order - 400 (invalide fieldname)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [Date] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Order - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Wed, 09 Mar 2022 01:21:25 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"62ae4fed-c086-4764-a970-aa5be35fb988"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [1600] not found"},"example":["Order with id [1600] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Update Order - 404":{"value":{"error":{"code":15001,"messages":["Order with id [1600] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Add items to an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/add-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Add items to an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/add-items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Add items to an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Orderlist items input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"productSources":{"description":"List of product sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistItemsInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Items added to orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown add items to orderlist error"}}}
>
  
</StatusCodes>

---

## Assign companies to an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/assign-companies.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Assign companies to an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/assign-companies"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Assign companies to an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Companies input","content":{"application/json":{"schema":{"type":"object","properties":{"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"default":[],"nullable":true,"type":"array","items":{"type":"array"}},"companySources":{"description":"List of company sources","example":[{"id":"1","name":"Source1"}],"nullable":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistCompaniesInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Companies assigned to orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown assign companies to orderlist error"}}}
>
  
</StatusCodes>

---

## Assign users to an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/assign-users.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Assign users to an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/assign-users"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Assign users to an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Users input","content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"description":"List of user ids","example":[1111,2222,3333],"default":[],"nullable":true,"type":"array","items":{"type":"array"}},"userSources":{"description":"List of user sources","example":[{"id":"1","name":"Source1"}],"nullable":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistUsersInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Users assigned to orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown assign users to orderlist error"}}}
>
  
</StatusCodes>

---

## Create a new orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/create-orderlist.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a new orderlist"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/orderlists"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Create orderlist input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"productSources":{"description":"List of product sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"type":{"type":"string","description":"Orderlist type. One of: [POSITIVE, NEGATIVE]","enum":["POSITIVE","NEGATIVE"]},"descriptions":{"description":"Orderlist descriptions per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"default":[],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userSources":{"description":"List of user sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companySources":{"description":"List of company sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"required":["type"],"title":"OrderlistCreateInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Orderlist created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"500":{"description":"Unknown create orderlist error"}}}
>
  
</StatusCodes>

---

## Delete a orderlist by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/delete-orderlist.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete a orderlist by id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/orderlists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a orderlist by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist id","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Orderlist deleted","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown delete orderlist error"}}}
>
  
</StatusCodes>

---

## Get a orderlist by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/get-orderlist-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get a orderlist by id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/orderlists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get a orderlist by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get a orderlist by id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized","content":{"application/json":{"examples":{"invalid_client_id":{"description":"invalid_client_id","summary":"invalid_client_id","value":{"ErrorCode":"invalid_client","Error":"ClientId is Invalid"}},"invalid_client_cred":{"description":"invalid_client_cred","summary":"invalid_client_cred","value":{"ErrorCode":"invalid_client","Error":"Client credentials are invalid"}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown get orderlist error"}}}
>
  
</StatusCodes>

---

## OrderLists API

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/orderlists-api.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 0.3.6"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"OrderLists API"}
>
</Heading>



OrderLists API

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div><div
  style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
  <h3
    style={{"marginBottom":"0.25rem"}}
  >
    Contact
  </h3><span>
    Propeller: [cloud@propel.us](mailto:cloud@propel.us)
  </span><span>
    URL: [https://propeller-commerce.com](https://propeller-commerce.com)
  </span>
</div>

---

## Remove items from an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/remove-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove items from an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/remove-items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Remove items from an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Orderlist items input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"productSources":{"description":"List of product sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistItemsInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Items removed from orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown remove items from orderlist error"}}}
>
  
</StatusCodes>

---

## Search orderlists

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/search-orderlists.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search orderlists"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/orderlists/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Search orderlists

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Search orderlists","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number","description":"Pagination page number. [Default to `1`]","default":1},"offset":{"type":"number","description":"Pagination offset number. [Default to `12`]","default":12},"ids":{"description":"List of Orderlist primary identifiers","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"type":{"type":"string","description":"Orderlist type. One of: [POSITIVE, NEGATIVE]","enum":["POSITIVE","NEGATIVE"]},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userSources":{"description":"List of user sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companySources":{"description":"List of company sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"productSources":{"description":"List of product sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterSources":{"description":"List of cluster sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"sortInputs":{"nullable":true,"description":"Inputs to sort by","example":[{"field":"createdAt","order":"asc"}],"type":"array","items":{"type":"object","properties":{},"title":"OrderlistSortInput"}}},"title":"OrderlistSearchInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Paginated list of orderlists","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type Orderlist","type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"OrderlistsResponse"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden."},"500":{"description":"Unknown get orderlists error"}}}
>
  
</StatusCodes>

---

## Unassign companies from an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/unassign-companies.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Unassign companies from an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/unassign-companies"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Unassign companies from an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Companies input","content":{"application/json":{"schema":{"type":"object","properties":{"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"default":[],"nullable":true,"type":"array","items":{"type":"array"}},"companySources":{"description":"List of company sources","example":[{"id":"1","name":"Source1"}],"nullable":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistCompaniesInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Companies unassigned from orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown companies users from orderlist error"}}}
>
  
</StatusCodes>

---

## Unassign users from an orderlist

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/unassign-users.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Unassign users from an orderlist"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}/unassign-users"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Unassign users from an orderlist

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Users input","content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"description":"List of user ids","example":[1111,2222,3333],"default":[],"nullable":true,"type":"array","items":{"type":"array"}},"userSources":{"description":"List of user sources","example":[{"id":"1","name":"Source1"}],"nullable":true,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistUsersInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Users unassigned from orderlist","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown unassign users from orderlist error"}}}
>
  
</StatusCodes>

---

## Update a orderlist by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orderlists/update-orderlist.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a orderlist by id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/orderlists/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update a orderlist by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Orderlist identifier","example":424242,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Update orderlist input","content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"productSources":{"description":"List of product sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterSources":{"description":"List of cluster sources","example":[{"name":"TRIMERGO","id":"A99999999"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"type":{"type":"string","description":"Orderlist type. One of: [POSITIVE, NEGATIVE]","enum":["POSITIVE","NEGATIVE"]},"descriptions":{"description":"Orderlist descriptions per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"default":[],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userSources":{"description":"List of user sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companySources":{"description":"List of company sources","example":[{"id":"1","name":"Source1"}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Source ID"},"name":{"type":"string","description":"Name of the source"}},"required":["id","name"],"title":"Source"}}},"title":"OrderlistUpdateDTO"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Orderlist updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Orderlist primary identifier","example":1234},"createdAt":{"format":"date-time","type":"string","description":"Orderlist creation date","example":"2022-01-01T00:00:00.000Z"},"lastModifiedAt":{"format":"date-time","type":"string","description":"Orderlist last modified date","example":"2022-01-02T00:00:00.000Z"},"descriptions":{"description":"Orderlist description per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"type":{"type":"string","description":"Orderlist type","enum":["POSITIVE","NEGATIVE"],"example":"POSITIVE"},"productIds":{"description":"List of product ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"clusterIds":{"description":"List of cluster ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"userIds":{"description":"List of user ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}},"companyIds":{"description":"List of company ids","example":[1111,2222,3333],"type":"array","items":{"type":"array"}}},"required":["id","createdAt","lastModifiedAt","type","productIds","clusterIds","userIds","companyIds"],"title":"Orderlist"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Orderlist not found"},"500":{"description":"Unknown update orderlist error"}}}
>
  
</StatusCodes>

---

## Orders

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/orders.tag

<LegacyBanner />



Order API exposes endpoints for creating, updating and searching orders. Additionally, endpoints for processing orders and managing order shipments are available.

## Fields

An order resource contains the fields below:

- fields available when creating an order via the API are marked in the **Create via POST** column.
- a smaller subset of these fields is updatable using the API, these are marked in the **Update via Patch** column.
    

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `id` | `order` id | integer | x |  |  |
| `shop` | `shop` identifier | JSON object | x |  |  |
| `status` | `order` status | string | x | x | x |
| `channelId` | `channel` id | integer | x | x |  |
| `shopId` | `shop` id | integer | x |  |  |
| `source` | external system | string |  | x | x |
| `sourceId` | external system unique id | string |  | x | x |
| `userId` | customer `user` id of | integer | x |  |  |
| `debtorId` | customer debtor Id | string | x | x |  |
| `firstName` | customer first name | string | x | x |  |
| `middleName` | customer middle name | string | x | x |  |
| `lastName` | customer last name | string | x | x |  |
| `email` | customer email | string | x | x |  |
| `type` | `order` type | enum  <br />  <br />dropshipment  <br />stock  <br />purchase  <br />quotation | x |  |  |
| `remarks` | `order` remarks | string | x | x |  |
| `reference` | `order` reference (e.g. po number) | string | x | x |  |
| `extraInfo` | `order` extra info | string | x | x |  |
| `language` | locale in which the `order` was created (e.g. EN-US) | string [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | x | x | `x` |
| `date` | order date | date | x | x |  |
| `orderSource` | `order` was create via which medium (webshop / backoffice / API) | string | x | x | x |
| `externalId` (deprecated) | external `order` id | string | x |  | x |
| `itemCount` | total number of `orderItems` | integer | x |  |  |
| `exportDate` | `order` export date | date |  | x | x |
| `exportStatus` | `order` export status | enum  <br />  <br />EXPORTED  <br />FAILED |  | x | x |
| `exportMessage` | `order` export message (e.g. a success or failed message) | string |  | x | x |
| `merchantCost` | costs calculated by a marketplace (e.g. Amazon) | integer | `x` | x |  |
| `accountingId` | identifier for accounting purposes | string | x | x |  |
| `trackTraceCode` | Track and trace codes of the `order` | string |  | x |  |
| `paymentData` |  | JSON object ([paymentData](#payment-data)) | x |  |  |
| `total` | object containing various calculation of summed items | JSON object ([total](#total)) | x | x |  |
| `postageData` |  | JSON object ([postageData](#postage-data)) | x | x | x |
| `clientData` | `user` / `contact` or `customer` object | JSON object | x | x |  |
| `invoiceData` | invoice `address` | JSON object | x | x |  |
| `shippingData` | shipment `address` | JSON object | x | x |  |
| `items` | order items | array ([items](/reference/legacy/rest-v1/orders#items)) | x |  |  |

## Payment data

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `payMethod` | method of payment, e.g. creditcard, on account, direct debit. The value should match the paymethod configured in the Propeller backoffice | string | x | x |  |
| `grossAmount` | cost of the payment excluding VAT (e.g. creditcard transaction costs) | integer | x | x |  |
| `netAmount` | cost of payment including VAT | integer | x |  |  |
| `payStatus` | status of the payment | string | x | x |  |
| `payStatusDate` | date of payment processing | date | x |  |  |
| `transactionId` | Identifier of the transaction, often this is an id returned by the payment service provider | string | x | x |  |

## Total

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `discountPercentage` | discount percentage on the total `order` amount | integer | x | x |  |
| `discountValue` | discount amount on the total `order` amount | integer | x | x |  |
| `totalNet` | total `order` amount including VAT | integer | x |  |  |
| `totalGross` | total `order` amount excluding VAT | integer | x |  |  |
| `tax` | total VAT amounts per Tax percentage of the combined order items | JSON object | x |  |  |

## Postage data

| **Name** | **Description** | **Type** | **Get order (GET)** | **Create order (POST)** | **Update order (PATCH)** |
| --- | --- | --- | --- | --- | --- |
| `requestDate` | `order` requested delivery date | date | x | x | x |
| `shippingMethod` | method of shipment, e.g. regular, dropshipment, pickup, etc. The value should match the shippingmethods configured in the Propeller backoffice | string | x | x |  |
| `postageTaxCode` | postage/shipping costs tax code | enum  <br />  <br />`H` = High  <br />`L` = Low  <br />`N` = None |  | x |  |
| `postageTaxPercentage` | postage/shipping cost tax percentage | integer | x |  |  |
| `postage` | postage/shipping costs excluding VAT | integer | x | x |  |
| `postageNet` | postage/shipping costs including VAT | integer | x |  |  |
| `partialDeliveryAllowed` | is partial delivery of the order allowed | enum  <br />  <br />`Y` = Yes  <br />`N` = No | x | x |  |
| `carrier` |  | string | x |  |  |
| `pickUpLocationId` |  | integer | x |  |  |

## Client data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `user` resource | all fields related to a `user` / `contact` / `customer` resource | [user](/reference/legacy/rest-v1/users) | x |  |  |
| `contact` | a reference by [lookup key](/reference/legacy/rest-v1/contacts#contact-lookup-keys) to an existing `contact` resource | JSON object |  | x |  |
| `customer` | a reference by [lookup key](/reference/legacy/rest-v1/customers#customer-lookup-keys) to an existing `customer` resource | JSON object |  | x |  |
| `user` | a reference by [lookup key](/reference/legacy/rest-v1/users#user-lookup-keys) to an existing `user` resource | JSON object |  | x |  |

## Invoice data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `address` | invoice address | JSON object (address) | x | x |  |

## Shipping data

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `address` | shipping address | JSON object (address) | x | x |  |

## Items

| **Name** | **Description** | **Type** | Get order (GET) | Create order (POST) | Update order (PATCH) |
| --- | --- | --- | --- | --- | --- |
| `type` | `orderItem` type | enum  <br />  <br />product | x | x |  |
| `product resource` | all fields related to a `product` resource | [product](/reference/legacy/rest-v1/products) | x |  |  |
| `childItems` | `product` child items | array\[[products](/reference/legacy/rest-v1/products)\] | x |  |  |
| `name` | `orderItem` name | string |  | x |  |
| `quantity` | `orderItem` quantity | integer |  | x |  |
| `price` | `orderItem` price | number |  | x |  |
| `originalPrice` | `product` default price | number | x |  |  |
| `notes` | `orderItem` notes | string |  | x |  |
| `sku` | `product` sku used for [product lookup](/reference/legacy/rest-v1/products#product-lookup-keys) | string |  | `x` |  |
| `supplier` | `product` supplier used for [product lookup](/reference/legacy/rest-v1/products#product-lookup-keys) | string |  | x |  |
| `supplierCode` | `product` suppliercode used for [product lookup](/reference/legacy/rest-v1/products#product-lookup-keys) | string |  | x |  |
| `source` | `product` source used for [product lookup](/reference/legacy/rest-v1/products#product-lookup-keys) | string |  | x |  |
| `sourceId` | `product` sourceId used for [product lookup](/reference/legacy/rest-v1/products#product-lookup-keys) | string |  | x |  |
| `turnoverGroup` | identifier for accounting purposes | string |  | x |  |
| `discountAmount` | sum of all item incentives applied by business rules | number | x |  |  |
| `discountAmountTotal` | discountAmount \* quantity | number | x |  |  |
| `discountPercentage` | discountAmount percentage of the item price | number | x |  |  |
| `discountAmountNet` | discountAmount + tax | number | x |  |  |
| `discountAmountTotalNet` | discountAmount \* quantity + tax | number | x |  |  |

## Order Lookup keys

| **identifier** | **Description** | **Type** |
| --- | --- | --- |
| `id` | Propellor `order`id | integer |
| `sourceId` | External system unique id. `sourceId` should be combined with `source` | string |
| `externalId` (deprecated) | id of an external system which is stored as externalId in the Propellor `order` | string |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Expanding resources

| **Query parameter** | **Description** |
| --- | --- |
| `orderItems` | Expand `orderItems` in the response payload |
| `orderItems`.product | Expand `product` details as part of the `orderItems` in the response payload |
| `sources` | Expand `sources` in the response payload |

## Order Errors

This section describes error codes specific for the `Order` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `15001` | OrderNotFound | 404 | Order does not exist | Order with such lookup key not found |
| `15002` | OrderNotProcessed | 400 | Order not processed | Order was not processed successfully |
| `15003` | ParentOrderNotFound | 404 | Parent order does not exist | Parent order with such lookup key not found. This error is typical when working with order sub-resources (e.g. addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | Order address does not exist |
| `15004` | OrderExists | 400 | Order already exists | When creating / updating an order the `sourceId / source` combination already exists in Propeller. |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Pricesheets

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/pricesheets.tag

<LegacyBanner />



Price sheets are a common and quite familiar concept in the e-commerce world. A price sheet can include the prices for products or groups of products i.e. categories. A single price sheet can be assigned to multiple users. Check the [Users endpoints](/reference/legacy/rest-v1/users) to learn how to assign a pricesheet to a user.

## Price Sheet Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller pricesheet id, auto-generated |
| `code` | string | Price sheet code |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Price sheet fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `code` | Price sheet code | string  <br />integer |
| `shopId` | Identifies the shop the pricesheet will be valid for | integer |
| `name` | Price sheet name | string |
| `description` | Price sheet description | string |

## Pricing

Pricing for products and categories can be defined for different resources: pricesheet which can be assigned for a user or usergroup, or directly define pricing for user or usergroup.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `categories` | List of categories and corresponding prices | array\[[PricingItem](/reference/legacy/rest-v1/pricesheets#pricing-item)\] |
| `products` | List of products and corresponding prices | array\[[PricingItem](/reference/legacy/rest-v1/pricesheets#pricing-item)\] |
| `shopId` | Identifies the shop the prices will be valid for.  <br />For pricesheet prices, `shopId` is inferred from pricesheet's `shopId`. For user type discounts, if not provided, a default one will be set (first shop found). | integer |

## Pricing Item

A pricing item identifies the resource for which the prices are defined. This resource can be a product or a category. The resource can be defined by either `id` or `sourceId` in combination with `source`. The pricing item also includes the price itself.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `id` | [Resource Id](/reference/legacy/rest-v1/api-reference#lookup-keys) | integer |
| `sourceId` | [Source Id](/reference/legacy/rest-v1/api-reference#lookup-keys) | string |
| `source` | [Source](/reference/legacy/rest-v1/api-reference#lookup-keys) | string |
| `pricing` | Price | [PricingElement](/reference/legacy/rest-v1/pricesheets#pricing-element) |

## Pricing Element

This field represents the actual price definition.

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `type` | Price type  <br />  <br />Cost price plus (CP) = The cost price of a product + `amount` percent  <br />Sales price minus (SP) = The sales price of a product - `amount` percent  <br />Net = Net `price` | enum  <br />  <br />CP  <br />SP  <br />net |
| `amount` | Percent. Should be used in combination with `type` SP or CP. | decimal |
| `price` | Net price. Should be used when `type` is net. | decimal |
| `quantity` | The minimum quantity for which this price is valid | integer |
| `validFrom` | The price is valid after this date | date |
| `validTo` | The price is valid before this date | date |

## Pricesheet/ Pricing Errors

This section describes error codes specific for the `Pricesheet` and `Pricing`resources.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `12001` | PricesheetExists | 400 | Pricesheet already exists | Pricesheet with such lookup key already exists |
| `12002` | PricesheetNotFound | 404 | Pricesheet not found | Pricesheet with such lookup key not found |
| `12003` | PricesheetPricingExists | 400 | Pricesheet already contains pricing | Pricesheet/ User/ Usergroup pricing already exists |
| `12004` | PricesheetPricingError | 400 | Error listing pricing | Error retrieveing pricing |
| `12005` | ParentPricesheetsNotFound | 404 | Parent resource pricesheet not found | Parent pricesheet with such lookup key not found. This error is typical when working with pricesheet pricing |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Process order by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/process-order-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Process order by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/orders/{lookupKey}/{lookupValue}/process"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Process an order by a specific lookupKey / lookupId combination.

| **lookupKeys** |
| --- |
| `id` |
| `externalId` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

Processing an order does the following:

1. for each supplier in the order a purchase order and backorder is created
2. the order is set to status CONFIRMED
    

Once an order is processed, [shipments / track and trace codes](/reference/legacy/rest-v1/orders) can be booked on backorders.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`\n\n`id` - Integer"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order \n\n`id` - Integer, `externalId` - String"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Process order by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"1948"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:38:11 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ccfe1260-b39d-45f7-a0f1-5135c1b578b1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"JS"},"company":{"type":"string","example":"Propellor"},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":"julielarue@propellor.eu"},"firstName":{"type":"string","example":"Jullien"},"fullName":{"type":"string","example":"Jullien Serres"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14718},"lastName":{"type":"string","example":"Serres"},"login":{"type":"string","example":"julielarue@propellor.eu"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"06-12345678"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-03-16T15:00:55"},"debtorId":{"type":"string","example":"753953"},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"id":{"type":"number","example":195},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":"w.spies@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81902},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":""},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":"+31206717171"},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat 20"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":0},"postageNet":{"type":"number","example":0},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Apeldoorn"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Julien"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81903},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Serres"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"20"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"7323 KE"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Mazurkastraat"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"siteId":{"type":"number","example":100037},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"11":{"type":"number","example":32.2234},"21":{"type":"number","example":0}}},"totalGross":{"type":"number","example":292.94},"totalNet":{"type":"number","example":325.1634}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14718}}},"messages":{"type":"array","items":{"type":"string","example":"Order processed"},"example":["Order processed"]},"total":{"type":"number","example":1}}},"examples":{"Process order by lookup key - 200":{"value":{"data":{"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-03-16T15:00:55","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":195,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81902,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81903,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"siteId":100037,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"11":32.2234,"21":0},"totalGross":292.94,"totalNet":325.1634},"type":"dropshipment","userId":14718},"messages":["Order processed"],"total":1}}}}}},"404":{"description":"Order process by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"160"}},"date":{"schema":{"type":"string","example":"Wed, 23 Mar 2022 15:38:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"54f24187-0fd5-42ad-a456-2f0aa887f653"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15001},"messages":{"type":"array","items":{"type":"string","example":"Order with id [295] not found"},"example":["Order with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"OrderNotFound"}}}}},"examples":{"Order process by lookup key - 404":{"value":{"error":{"code":15001,"messages":["Order with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15001","status":404,"type":"OrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Products

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/products.tag

<LegacyBanner />



Products are the sellable goods in an e-commerce shop on the Propeller platform. They are usually organized hierarchically in [categories](/reference/legacy/rest-v1/categories). The Product API can be used to consult, create, update or delete a Product.

## Product Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller product id, auto-generated |
| `sourceId` | string | External system unique id. `sourceId` should be combined with `source` |
| `sku` | string | Product SKU/ code |
| `code` (deprecated) | string | Product code |
| `supplierCode` | string | Product code as known to the product supplier. `supplierCode` should be combined with `supplier` |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `names` | Product name | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `language` | Product default language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent category | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `sku` | Product SKU (code) | string |
| `unit` | The number of packages that need to be ordered when adding an item to the basket | integer |
| `status` | Product status | enum  <br />  <br />**A**\=Available  <br />**N**\=Not available  <br />**T**\=Out of stock  <br />**P**\=Phase out  <br />**S**\=Presale  <br />**R**\=Restricted |
| `price` | Sales price | decimal |
| `costPrice` | Cost price | decimal |
| `suggestedPrice` | Suggested/ advised price | decimal |
| `discountPrice` | Discount price | decimal |
| `discountPriceFrom` | Discount price from date | date |
| `discountPriceTo` | Discount price to date | date |
| `priceDisplay` | Type of price display | enum  <br />  <br />**default** = Only display price  <br />**onrequest** = Do not show price, show "Price on request"  <br />**from** = Show cheapest price  <br />**fromfor** = Show old (suggested) price vs. new price  <br />**perpackage** = price per type of package (e.g. Price from € 125.50 per box)  <br />**peruom** = Cheapest price per package unit (e.g. Price from € 125.50 per piece) |
| `descriptions` | Product description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `shortName` | Product short name | string |
| `shortDescriptions` | Product short descriptions | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `taxCode` | Product tax code | enum  <br />  <br />**H**\=High  <br />**L**\=Low  <br />**N**\=None |
| `supplier` | Product supplier | string |
| `supplierCode` | Product code as known to the product supplier | string |
| `manufacturer` | Manufacturer | string |
| `oemCode` | Product manufacturer code | string |
| `eanCode` | Product EAN code | string |
| `minimumQuantity` | Minimum orderable quantity | integer |
| `package` | Package (e.g. piece, sheet, etc.) | string |
| `packageDescriptions` | Description of package and  <br />package units inside a  <br />package (e.g. Box of 650 sheets of paper) | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `notes` | Product notes/ remarks | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `sourceId` | External system unique id | string |
| `source` | External system | string |
| `keywords` | Keywords of this product per language. Added by the supplier | array\[[LocalizedString](/reference/rest/endpoints/api-reference#localized-string)\] |
| `customKeywords` | Additional keywords of this product per language. Added via the PIM | array\[[LocalizedString](/reference/rest/endpoints/api-reference#localized-string)\] |
| `statusExtra` | The extra status of this product, commonly linked to a custom valueset | string |
| `orderable` | Indicates whether the product is orderable | enum  <br />  <br />Y = Yes  <br />N = No |
| `orderableFrom` | The orderable from date of this product | date |
| `orderableTo` | The orderable from to of this product | date |
| `releaseDate` | The release date of this product | date |
| `returnable` | Indicates whether the product is returnable | enum  <br />  <br />Y = Yes  <br />N = No |
| `physical` | Is it a physical product or a service, download or warranty | enum  <br />  <br />Y = Yes  <br />N = No |
| `barCode` | The bar code of this product | string |
| `width` | Product width | string |
| `height` | Product height | string |
| `depth` | Product depth | string |
| `weight` | Product weight | string |
| `packageUnit` | The amount of items per package | string |
| `packageUnitQuantity` | The quantifier for the package unit, i.e.: PIECE or BOX | string |
| `purchaseMinimumQuantity` | The minimum quantity of products that can be ordered when creating a purchase order | integer |
| `purchaseUnit` | The unit in which the product can be ordered when creating a purchase order | integer |
| `economicOrderQuantity` | The quantity that provides the best value for money for this product | integer |
| `metadataTitles` | Metadata title | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataDescriptions` | Metadata description | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataKeywords` | Metadata keywords | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `metadataCanonicalUrls` | Metadata canonical URL | array\[[LocalizedString](/reference/legacy/rest-v1/api-reference#localized-string)\] |
| `priority` | Sort products based on the priority in search results | integer |

## Product Errors

This section describes error codes specific for the `Product` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `80004` | ProductExists | 400 | Product already exists | Category with such lookup key already exists |
| `80005` | ProductMultipleFound | 400 | Multuple products found. Please provide additional filters | Multiple products with such lookup key exist |
| `80006` | ProductNotFound | 404 | Product does not exist | Product with such lookup key not found |
| `80007` | ParentProductNotFound | 404 | Parent product not found | Parent product with such lookup key not found. This error is typical when working with product sub-resources (e.g. attributes) |
| `80008` | ProductNotAllowed | 405 | Product is not allowed | No permission for the product |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Remove Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/remove-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete cluster config by lookup key.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"8"},"description":"The value of the key (id or name)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Remove Cluster Config - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"51"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:02:58 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"57071cd3-b8d9-4112-a08d-3b16e1d28052"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config deleted"},"example":["Cluster Config deleted"]}}},"examples":{"Remove Cluster Config - 200":{"value":{"data":{},"messages":["Cluster Config deleted"]}}}}}},"404":{"description":"Remove Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"175"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:04:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"308b6bfb-2a06-4fc7-903d-b7dec33b6de2"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21005},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config with id [7] not found"},"example":["Cluster Config with id [7] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21005"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigNotFound"}}}}},"examples":{"Remove Cluster Config - 404":{"value":{"error":{"code":21005,"messages":["Cluster Config with id [7] not found"],"moreInfo":"https://www.propel.us/docs/errors/21005","status":404,"type":"ClusterConfigNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Remove Setting from Cluster Config

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/remove-setting-from-cluster-config.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Remove Setting from Cluster Config"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings/{settingId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"},{"name":"settingId","in":"path","required":true,"schema":{"type":"string","example":"116"},"description":"The id of cluster config setting"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Remove Setting from Cluster Config - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"59"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:01:28 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"ef96dc84-ebbd-4a4d-92d6-a8bedd2d7652"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config setting deleted"},"example":["Cluster Config setting deleted"]}}},"examples":{"Remove Setting from Cluster Config - 200":{"value":{"data":{},"messages":["Cluster Config setting deleted"]}}}}}},"404":{"description":"Remove Setting from Cluster Config - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"192"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:01:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"131ed70f-1bc1-45a7-88c8-9385c2d484a1"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21007},"messages":{"type":"array","items":{"type":"string","example":"Cluster config setting with id [117] not found"},"example":["Cluster config setting with id [117] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigSettingNotFound"}}}}},"examples":{"Remove Setting from Cluster Config - 404":{"value":{"error":{"code":21007,"messages":["Cluster config setting with id [117] not found"],"moreInfo":"https://www.propel.us/docs/errors/21007","status":404,"type":"ClusterConfigSettingNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Rules execute

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/rules-execute.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Rules execute"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/rules/{resource}/execute"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Executes rules for the selected resource.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"shopId","in":"query","schema":{"type":"string","example":"1"},"description":"Provide for `resource` of type `orders`. Otherwise ignored. Defaults to first shop"},{"name":"resource","in":"path","required":true,"schema":{"type":"string","example":"products"},"description":"Type of rules to execute:\n\norders\nusers\nproducts"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Rules reset

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/rules-reset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Rules reset"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/rules/{resource}/reset"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Propeller keeps track on which entities rules have been executed. Once all rules have been executed on an entity it will be internally marked as 'rules applied' and executing the rules execute endpoint again will not trigger the rules for this entity anymore.

There are two ways of 'resetting' the 'rules applied' value:

1. update the entity (either via the Propeller back office or API)
2. by using the rules reset endpoint.
    

The rules reset endpoint resets the 'rules applied' value for all entities.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"shopId","in":"query","schema":{"type":"string","example":"1"},"description":"Provide for `resource` of type `orders`. Otherwise ignored. Defaults to first shop"},{"name":"resource","in":"path","required":true,"schema":{"type":"string","example":"orders"},"description":"Type of rules to execute:\n\nusers\nproducts"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":""}}}
>
  
</StatusCodes>

---

## Rules

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/rules.tag

<LegacyBanner />



The Propeller rules engine allows for fast and easy data formatting and/or structuring. Based on certain conditions, actions on orders, products or users will be executed.



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Search attributes

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-attributes.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search attributes"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/attributes/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a list of attributes by using the search fields below:

| **Field** | **Type** |
| --- | --- |
| `ids` | array(int) |
| `names` | array(string) |
| `class` | string |
| `isPublic` | boolean |
| `isSearchable` | boolean |
| `isHidden` | boolean |
| `isSystem` | boolean |
| `offset` | int (max: `100``) |
| `page` | int |

Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination). The default number of attributes per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"array","items":{"type":"number","example":716},"example":[716,717]},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"string","example":"COLOR"},"example":["COLOR","WEIGHT"]},"offset":{"type":"number","example":10},"page":{"type":"number","example":1}}},"examples":{"Search attributes":{"value":{"class":"product","id":[716,717],"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"names":["COLOR","WEIGHT"],"offset":10,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search attributes - 200 (with results) / Search attributes - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"84"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 09:52:42 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"917f82b7-deb3-4df4-89ad-c49c87011f00"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","example":"product"},"defaultLanguage":{"type":"string","example":"EN"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"Weight"}}},"example":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":661},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"name":{"type":"string","example":"WEIGHT"},"type":{"type":"string","example":"decimal"},"typeParam":{"type":"string","example":""},"units":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"value":{"type":"string","example":"kg"}}},"example":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}]},"value":{"example":0,"anyOf":[{"type":"number","example":0},{"type":"string","example":""}]}}},"example":[{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}],"group":"","id":661,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}],"value":0},{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""}]},"end":{"type":"number","example":2},"itemsFound":{"type":"number","example":2},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":10},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":2}}},"examples":{"Search attributes - 200 (no results)":{"value":{"data":[],"itemsFound":0,"messages":["Completed"],"offset":10,"page":1,"total":1}},"Search attributes - 200 (with results)":{"value":{"data":[{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Weight"},{"language":"NL","value":"Gewicht"}],"group":"","id":661,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"WEIGHT","type":"decimal","typeParam":"","units":[{"language":"EN","value":"kg"},{"language":"NL","value":"kg"}],"value":0},{"class":"product","defaultLanguage":"EN","descriptions":[{"language":"EN","value":"Color"},{"language":"NL","value":"Kleur"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"name":"COLOR","type":"enum","typeParam":"COLORS","units":[{"language":"EN","value":""},{"language":"NL","value":""}],"value":""}],"end":2,"itemsFound":2,"messages":["Completed"],"offset":10,"page":1,"pages":1,"start":1,"total":2}}}}}},"400":{"description":"Search attributes - 400 (invalid search fields)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"182"}},"date":{"schema":{"type":"string","example":"Tue, 08 Mar 2022 09:53:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"1132c373-b2a4-4406-96bf-24a0dc1e709e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [id] is not permitted"},"example":["#: extraneous key [id] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search attributes - 400 (invalid search fields)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [id] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Companies

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-companies.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Companies"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/companies/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The companies search endpoint is only available on the Propeller cloud version. 
  

Retrieves a list of companies by using the search fields below. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `dateCreated` | [DateFilter](#date-filter) |
| `dateModified` | [DateFilter](#date-filter) |
| `debtorIds` | array(string) |
| `offset` | integer |
| `page` | integer |

## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for companies like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"debtorId":{"type":"string","example":"755632"},"name":{"type":"string","example":"Sander"},"offset":{"type":"number","example":12},"page":{"type":"number","example":1}}},"examples":{"Search Companies":{"value":{"dateCreated":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"debtorId":{"type":"array","items":{"type":"string","example":"755632"}},"name":"Sander","offset":12,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Companies - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"3260"}},"date":{"schema":{"type":"string","example":"Thu, 31 Aug 2023 11:35:34 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"67338ba0-55ee-4a7b-847d-acf1f3c90a60"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"cocNumber":{"type":"string","example":""},"company":{"type":"string","example":""},"dateCreated":{"type":"string","example":"2023-05-19T11:46:20"},"dateModified":{"type":"string","example":"2023-05-19T11:46:20"},"debtorId":{"type":"string","example":"755632"},"defaultobjectId":{"example":"","anyOf":[{"type":"string","example":""},{"type":"number","example":944644},{"type":"string","example":""},{"type":"string","example":""},{"type":"string","example":""},{"type":"string","example":""}]},"department":{"type":"string","example":""},"id":{"type":"number","example":9478},"inheritOrderList":{"type":"string","example":"Y"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Comapny 1"},"notes":{"type":"string","example":""},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"taxNumber":{"type":"string","example":"123456"},"userManagerId":{"type":"string","example":""}}},"example":[{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T11:46:20","dateModified":"2023-05-19T11:46:20","debtorId":"755632","defaultobjectId":"","department":"","id":9478,"inheritOrderList":"Y","inheritProductList":"Y","name":"Comapny 1","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T11:54:55","dateModified":"2023-05-19T11:54:55","debtorId":"755632","defaultobjectId":"","department":"","id":9479,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 2","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T13:38:00","dateModified":"2023-05-19T13:38:00","debtorId":"755632","defaultobjectId":"","department":"","id":9481,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 3","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"","dateCreated":"2023-05-22T15:11:46","dateModified":"2023-05-23T09:57:24","debtorId":"755632","defaultobjectId":944644,"department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","name":"Propellor Company","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"75564998","company":"","dateCreated":"2023-05-22T15:39:13","dateModified":"2023-05-22T15:39:12","debtorId":"755632","defaultobjectId":"","department":"","id":9483,"inheritOrderList":"N","inheritProductList":"Y","name":"Propeller Nr.2","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:32:55","dateModified":"2023-05-26T16:33:19","debtorId":"755632","defaultobjectId":"","department":"","id":9484,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 4","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:45:45","dateModified":"2023-05-26T16:45:45","debtorId":"755632","defaultobjectId":"","department":"","id":9485,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 5","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:53:28","dateModified":"2023-05-26T16:54:34","debtorId":"755632","defaultobjectId":"","department":"","id":9486,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 6","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""}]},"end":{"type":"number","example":6188},"itemsFound":{"type":"number","example":6188},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":516},"pages":{"type":"number","example":516},"start":{"type":"number","example":6181},"total":{"type":"number","example":8}}},"examples":{"Search Companies - 200":{"value":{"data":[{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T11:46:20","dateModified":"2023-05-19T11:46:20","debtorId":"755632","defaultobjectId":"","department":"","id":9478,"inheritOrderList":"Y","inheritProductList":"Y","name":"Comapny 1","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T11:54:55","dateModified":"2023-05-19T11:54:55","debtorId":"755632","defaultobjectId":"","department":"","id":9479,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 2","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-19T13:38:00","dateModified":"2023-05-19T13:38:00","debtorId":"755632","defaultobjectId":"","department":"","id":9481,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 3","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"","dateCreated":"2023-05-22T15:11:46","dateModified":"2023-05-23T09:57:24","debtorId":"755632","defaultobjectId":944644,"department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","name":"Propellor Company","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"75564998","company":"","dateCreated":"2023-05-22T15:39:13","dateModified":"2023-05-22T15:39:12","debtorId":"755632","defaultobjectId":"","department":"","id":9483,"inheritOrderList":"N","inheritProductList":"Y","name":"Propeller Nr.2","notes":"Company created from API","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:32:55","dateModified":"2023-05-26T16:33:19","debtorId":"755632","defaultobjectId":"","department":"","id":9484,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 4","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:45:45","dateModified":"2023-05-26T16:45:45","debtorId":"755632","defaultobjectId":"","department":"","id":9485,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 5","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","cocNumber":"","company":"","dateCreated":"2023-05-26T16:53:28","dateModified":"2023-05-26T16:54:34","debtorId":"755632","defaultobjectId":"","department":"","id":9486,"inheritOrderList":"Y","inheritProductList":"Y","name":"Company 6","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","taxNumber":"123456","userManagerId":""}],"end":6188,"itemsFound":6188,"messages":["Completed"],"offset":12,"page":516,"pages":516,"start":6181,"total":8}}}}}},"400":{"description":"Search Companies - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 22 Aug 2023 08:28:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"9e835215-24c1-4a99-99b4-b1f808ec3215"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Companies - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Contacts

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-contacts.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Contacts"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/contacts/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The contacts search endpoint is only available on the Propeller cloud version. 
  

Retrieves a list of contacts by using the search fields below. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `debtorIds` (deprecated) | array(string) |
| `dateCreated` | [DateFilter](#date-filter) |
| `dateModified` | [DateFilter](#date-filter) |
| `offset` | integer |
| `page` | integer |

## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for contacts like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"name":{"type":"string","example":"Sander"},"offset":{"type":"number","example":12},"page":{"type":"number","example":1}}},"examples":{"Search Contacts":{"value":{"dateCreated":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"name":"Sander","offset":12,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Contacts - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"1025"}},"date":{"schema":{"type":"string","example":"Wed, 30 Aug 2023 10:36:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e19249c6-3532-497a-b1e0-6957946f2138"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateCreated":{"type":"string","example":"2023-05-23T09:28:32"},"dateModified":{"type":"string","example":"2023-05-23T10:14:24"},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25492},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"name":{"type":"string","example":"Miles McCoy"},"phone":{"type":"string","example":"0032445888"},"pricelistAmount":{"type":"string","example":""},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":"EN"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","dateCreated":"2023-05-23T09:28:32","dateModified":"2023-05-23T10:14:24","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25492,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0032445888","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},{"abbreviation":"MM","dateCreated":"2023-05-24T14:39:47","dateModified":"2023-05-24T14:40:42","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25496,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"NL","ssn":"","title":"Mr."}]},"end":{"type":"number","example":2},"itemsFound":{"type":"number","example":2},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":2}}},"examples":{"Search Contacts - 200":{"value":{"data":[{"abbreviation":"MM","dateCreated":"2023-05-23T09:28:32","dateModified":"2023-05-23T10:14:24","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25492,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0032445888","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},{"abbreviation":"MM","dateCreated":"2023-05-24T14:39:47","dateModified":"2023-05-24T14:40:42","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25496,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"NL","ssn":"","title":"Mr."}],"end":2,"itemsFound":2,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":2}}}}}},"400":{"description":"Search Contacts - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 22 Aug 2023 08:24:46 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"d54c0c06-d1de-4363-8a7d-393a7a77d161"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Contacts - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Customers

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-customers.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Customers"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/customers/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The customers search endpoint is only available on the Propeller cloud version. 
  

Retrieves a list of customers by using the search fields below. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `debtorIds` | array(string) |
| `dateCreated` | [DateFilter](#date-filter) |
| `dateModified` | [DateFilter](#date-filter) |
| `offset` | integer |
| `page` | integer |

## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for customers like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"name":{"type":"string","example":"Sander"},"offset":{"type":"number","example":12},"page":{"type":"number","example":1}}},"examples":{"Search Customers":{"value":{"dateCreated":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"name":"Sander","offset":12,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Customers - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"1043"}},"date":{"schema":{"type":"string","example":"Thu, 31 Aug 2023 11:22:29 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"e2ae5f24-40b6-46c0-a2c9-221fe16cdfe4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateCreated":{"type":"string","example":"2023-05-23T11:35:59"},"dateModified":{"type":"string","example":"2023-05-23T11:54:56"},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25494},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0032445888"},"name":{"type":"string","example":"Miles McCoy"},"phone":{"type":"string","example":"0032445888"},"pricelistAmount":{"type":"string","example":""},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":"EN"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","dateCreated":"2023-05-23T11:35:59","dateModified":"2023-05-23T11:54:56","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25494,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0032445888","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},{"abbreviation":"SV","dateCreated":"2023-06-07T13:40:40","dateModified":"2023-08-31T13:22:19","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"sander.v@gmail.com","fax":"","firstName":"Sander","gender":"M","id":25513,"lastName":"Vleugelhof","login":"sander.v@gmail.com","middleName":"","mobile":"0032445888","name":"Sander Vleugelhof","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."}]},"end":{"type":"number","example":2},"itemsFound":{"type":"number","example":2},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":2}}},"examples":{"Search Customers - 200":{"value":{"data":[{"abbreviation":"MM","dateCreated":"2023-05-23T11:35:59","dateModified":"2023-05-23T11:54:56","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","gender":"M","id":25494,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0032445888","name":"Miles McCoy","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."},{"abbreviation":"SV","dateCreated":"2023-06-07T13:40:40","dateModified":"2023-08-31T13:22:19","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"sander.v@gmail.com","fax":"","firstName":"Sander","gender":"M","id":25513,"lastName":"Vleugelhof","login":"sander.v@gmail.com","middleName":"","mobile":"0032445888","name":"Sander Vleugelhof","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","title":"Mr."}],"end":2,"itemsFound":2,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":2}}}}}},"400":{"description":"Search Customers - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 22 Aug 2023 08:26:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"1da8c50c-e46e-4586-b9ae-1f40c24d8452"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Customers - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Inventory"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/inventory/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.

### Available search fields

| **Name** | **Description** | **Required** |
| --- | --- | --- |
| `productIds` (array \[integer\]) | Array of product ids. | yes |
| `warehouseId` (integer) | Warehouse id. | no |
| `location` (string) | Location. | no |

Mandatory field in search payload is productIds array. If warehouseId or location are not sent in the payload, inventories will not be filtered by warehouse and/or location.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"inventoryBalance"},"description":"Expands cumulative inventory data with detailed records"},{"name":"offset","in":"query","schema":{"type":"string","example":"15"},"description":"Number of records per page. Default value is 12"},{"name":"page","in":"query","schema":{"type":"string","example":"8"},"description":"Page number. Default value is 1"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","example":""},"productIds":{"type":"array","items":{},"example":[]}}},"examples":{"Search Inventory":{"value":{"location":"","productIds":[]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Inventory - 200 / Search Inventory - 200 (expands inventoryBalance)","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"585"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:25:25 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"localQuantity":{"type":"number","example":20},"localReservedQuantity":{"type":"number","example":0},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"productId":{"type":"number","example":37232},"supplierQuantity":{"type":"number","example":0},"supplierReservedQuantity":{"type":"number","example":164},"totalQuantity":{"type":"number","example":20},"totalReservedQuantity":{"type":"number","example":164}}},"example":[{"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0},{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}]},"end":{"type":"number","example":3},"itemsFound":{"type":"number","example":3},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":3}}},"examples":{"Search Inventory - 200":{"value":{"data":[{"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0},{"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164}],"end":3,"itemsFound":3,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":3}},"Search Inventory - 200 (expands inventoryBalance)":{"value":{"data":[{"balance":[{"companyId":0,"costPrice":25.5,"dateModified":"2022-06-20T13:40:00","id":1,"location":"","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":37232,"quantity":20,"sku":"","supplier":"","supplierCode":"757540","usergroupId":0,"warehouseId":""},{"companyId":0,"costPrice":0,"dateModified":"2022-08-29T21:27:39","id":16132,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":37232,"quantity":3,"sku":"757540","supplier":"INTERN","supplierCode":"757540","usergroupId":0,"warehouseId":2},{"companyId":0,"costPrice":0,"dateModified":"2022-08-29T21:29:17","id":16138,"location":"","nextDeliveryDate":"","notes":"","productId":37232,"quantity":3,"sku":"757540","supplier":"INTERN","supplierCode":"757540","usergroupId":0,"warehouseId":0}],"localQuantity":26,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":37232,"supplierQuantity":0,"supplierReservedQuantity":0,"totalQuantity":26,"totalReservedQuantity":0},{"balance":[{"companyId":227583,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16139,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":87,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":11.31,"dateModified":"2023-09-28T19:56:35","id":16140,"location":"L5","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":16,"sku":"NCABD70004","supplier":"KERRIDGE","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:54:11","id":16141,"location":"B45","nextDeliveryDate":"2021-03-01T00:00:00","notes":"","productId":227237,"quantity":77,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},{"companyId":0,"costPrice":400.95,"dateModified":"2023-09-29T17:12:48","id":16142,"location":"","nextDeliveryDate":"","notes":"","productId":227237,"quantity":82,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":0,"warehouseId":0}],"localQuantity":0,"localReservedQuantity":0,"nextDeliveryDate":"2021-03-01T00:00:00","productId":227237,"supplierQuantity":246,"supplierReservedQuantity":164,"totalQuantity":262,"totalReservedQuantity":164},{"balance":[{"costPrice":25.5,"dateModified":"2022-06-20T13:40:00","id":1,"location":"","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":37232,"quantity":20,"sku":"","supplier":"","supplierCode":"757540","warehouseId":""}],"localQuantity":20,"nextDeliveryDate":"2022-02-20T00:00:00","productId":37232,"supplierQuantity":0,"totalQuantity":20},{"balance":[],"localQuantity":0,"nextDeliveryDate":"","productId":227197,"supplierQuantity":0,"totalQuantity":0}],"end":3,"itemsFound":3,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":3}}}}}},"400":{"description":"Search Inventory - 400 (empty productIds array)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"197"}},"Date":{"schema":{"type":"string","example":"Wed, 22 Jun 2022 07:26:31 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/productIds: expected minimum item count: 1, found: 0"},"example":["#/productIds: expected minimum item count: 1, found: 0"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Inventory - 400 (empty productIds array)":{"value":{"error":{"code":10007,"messages":["#/productIds: expected minimum item count: 1, found: 0"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Links

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-links.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Links"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/links/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves a list of links by using the search fields below:

| **Field** | **Type** |
| --- | --- |
| `type` | string |
| `subtype` | string |
| `from` | JSON object |
| `to` | JSON object |
| `isActive` | boolean |
| `isDefault` | boolean |
| `priority` | int |
| `offset` | int (max: `100`, default: `12`) |
| `page` | int |

Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination). The default number of links per page is `12`, but can be up to `100`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"ids":{"type":"array","items":{"type":"number","example":24603},"example":[24603]}}},"offset":{"type":"number","example":100},"page":{"type":"number","example":1},"prioritye":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"ids":{"type":"array","items":{"type":"number","example":27401},"example":[27401]}}},"type":{"type":"string","example":"accessories"}}},"examples":{"Search Links":{"value":{"from":{"class":"product","ids":[24603]},"offset":100,"page":1,"prioritye":0,"subtype":"Extrasale","to":{"class":"product","ids":[27401]},"type":"accessories"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Links - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"1182"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:08:32 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dateChanged":{"type":"string","example":"2018-11-08T11:35:38"},"from":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":24603}}},"id":{"type":"number","example":485377},"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":false},"priority":{"type":"number","example":0},"subtype":{"type":"string","example":"Extrasale"},"to":{"type":"object","properties":{"class":{"type":"string","example":"product"},"id":{"type":"number","example":27401}}},"type":{"type":"string","example":"accessories"}}},"example":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485378,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24235},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485379,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24005},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485380,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24063},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485381,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24035},"type":"accessories"}]},"end":{"type":"number","example":5},"itemsFound":{"type":"number","example":5},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":100},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":5}}},"examples":{"Search Links - 200":{"value":{"data":[{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485377,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":27401},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485378,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24235},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485379,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24005},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485380,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24063},"type":"accessories"},{"dateChanged":"2018-11-08T11:35:38","from":{"class":"product","id":24603},"id":485381,"isActive":true,"isDefault":false,"priority":0,"subtype":"Extrasale","to":{"class":"product","id":24035},"type":"accessories"}],"end":5,"itemsFound":5,"messages":["Completed"],"offset":100,"page":1,"pages":1,"start":1,"total":5}}}}}},"400":{"description":"Search Links - 400","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"189"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:10:37 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [prioritye] is not permitted"},"example":["#: extraneous key [prioritye] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Links - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [prioritye] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Orders

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-orders.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Orders"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/orders/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve a list of orders by using the search fields below

| **Name** | **Type** | **Required** |
| --- | --- | --- |
| `status` | string | no |
| `exported` | boolean | no |
| `externalOrderNumber` | string | no |
| `dateCreated` | [DateFilter](#date-filter) | no |
| `dateStatusModified` | [DateFilter](#date-filter) | no |

**status:** the value of the status in Propeller. By default the available statuses are:

*   NEW
*   VALIDATED
*   CONFIRMED
*   ARCHIVED
    

It is possible to create custom statuses in Propeller, please consult the Propeller backoffice for custom status values.

**exported:** Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Once an order has been exported it is good practice to mark the order as exported using the `order` update api. Searching for orders using the exported field will return a list of orders which are (or not) exported to an external system.

**externalOrderNumber:** Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Depending on the type of system / techniques used for exporting, Propeller gets back an identifier from these systems (e.g an order id / invoice id). This id is stored in Propellor and can be used for searching using the order search api.
## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"orderItems"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"extraStatus":{"type":"string","example":"CONFIRMED"}}},"examples":{"Search Orders":{"value":{"extraStatus":"CONFIRMED"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Orders - 200  (with results) / Search Orders - 200 (no results)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"37"}},"date":{"schema":{"type":"string","example":"Mon, 28 Feb 2022 17:07:45 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"065d03d1-41e2-42e8-b2a0-82fd3330c106"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"channelId":{"type":"number","example":1},"clientData":{"type":"object","properties":{"abbreviation":{"type":"string","example":"SV"},"company":{"type":"string","example":""},"dateOfBirth":{"type":"string","example":""},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":"sander123@propel.us"},"firstName":{"type":"string","example":"Sander"},"fullName":{"type":"string","example":"Sander Vleugelhof"},"gender":{"type":"string","example":"U"},"id":{"type":"number","example":14711},"lastName":{"type":"string","example":"Vleugelhof"},"login":{"type":"string","example":"sander123@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"undefined"},"phone":{"type":"string","example":"020-6717171"},"ssn":{"type":"string","example":""},"title":{"type":"string","example":""},"vatNumber":{"type":"string","example":""}}},"date":{"type":"string","example":"2022-02-24T14:14:55"},"debtorId":{"type":"string","example":""},"email":{"type":"string","example":""},"externalId":{"type":"string","example":""},"extraInfo":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"id":{"type":"number","example":162},"invoiceData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81752},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"invoice"},"url":{"type":"string","example":""}}}}},"itemCount":{"type":"number","example":1},"language":{"type":"string","example":"EN-US"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"paymentData":{"type":"object","properties":{"grossAmount":{"type":"number","example":0},"netAmount":{"type":"number","example":0},"payMethod":{"type":"string","example":""},"payStatus":{"type":"string","example":""},"paystatusdate":{"type":"string","example":""},"tax":{"type":"number","example":0},"taxPercentage":{"type":"number","example":21},"transactionId":{"type":"string","example":""}}},"postageData":{"type":"object","properties":{"carrier":{"type":"string","example":""},"partialDeliveryAllowed":{"type":"string","example":"Y"},"postage":{"type":"number","example":5},"postageNet":{"type":"number","example":6.05},"postageTaxPercentage":{"type":"number","example":21},"requestDate":{"type":"string","example":""},"shippingMethod":{"type":"string","example":""}}},"reference":{"type":"string","example":""},"remarks":{"type":"string","example":""},"shippingData":{"type":"object","properties":{"address":{"type":"object","properties":{"active":{"type":"string","example":"Y"},"city":{"type":"string","example":"Amsterdam"},"code":{"type":"string","example":""},"company":{"type":"string","example":""},"country":{"type":"string","example":"NL"},"email":{"type":"string","example":""},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Sander"},"gender":{"type":"string","example":"U"},"icp":{"type":"string","example":"N"},"id":{"type":"number","example":81753},"isDefault":{"type":"string","example":"N"},"lastName":{"type":"string","example":"Vleugelhof"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":""},"name":{"type":"string","example":""},"notes":{"type":"string","example":""},"number":{"type":"string","example":"257"},"numberExtension":{"type":"string","example":""},"phone":{"type":"string","example":""},"postalCode":{"type":"string","example":"1234 AB"},"region":{"type":"string","example":""},"street":{"type":"string","example":"Gedempt Hamerkanaal"},"type":{"type":"string","example":"delivery"},"url":{"type":"string","example":""}}}}},"shopId":{"type":"number","example":1},"source":{"type":"string","example":"intern"},"status":{"type":"string","example":"CONFIRMED"},"total":{"type":"object","properties":{"discountPercentage":{"type":"number","example":0},"discountValue":{"type":"number","example":0},"tax":{"type":"object","properties":{"21":{"type":"number","example":3.15}}},"totalGross":{"type":"number","example":20},"totalNet":{"type":"number","example":24.2}}},"type":{"type":"string","example":"dropshipment"},"userId":{"type":"number","example":14711}}},"example":[{"channelId":1,"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T03:11:58","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":165,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81765,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81766,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T10:45:20","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":166,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81773,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81774,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":6.3},"totalGross":35,"totalNet":42.35},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T14:56:59","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":167,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81779,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81780,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":5.9073},"totalGross":33.13,"totalNet":40.0873},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T19:04:27","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":169,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81793,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81794,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":23.31},"totalGross":111,"totalNet":134.31},"type":"dropshipment","userId":14718}]},"messages":{"type":"array","items":{},"example":[]},"total":{"type":"number","example":5}}},"examples":{"Search Orders - 200  (with results)":{"value":{"data":[{"channelId":1,"clientData":{"abbreviation":"SV","company":"","dateOfBirth":"","debtorId":"","email":"sander123@propel.us","firstName":"Sander","fullName":"Sander Vleugelhof","gender":"U","id":14711,"lastName":"Vleugelhof","login":"sander123@propel.us","middleName":"","mobile":"undefined","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-24T14:14:55","debtorId":"","email":"","externalId":"","extraInfo":"","firstName":"Sander","id":162,"invoiceData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81752,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Vleugelhof","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Amsterdam","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Sander","gender":"U","icp":"N","id":81753,"isDefault":"N","lastName":"Vleugelhof","middleName":"","mobile":"","name":"","notes":"","number":"257","numberExtension":"","phone":"","postalCode":"1234 AB","region":"","street":"Gedempt Hamerkanaal","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14711},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T03:11:58","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":165,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81765,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81766,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":3.15},"totalGross":20,"totalNet":24.2},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T10:45:20","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":166,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81773,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":1,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81774,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":6.3},"totalGross":35,"totalNet":42.35},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T14:56:59","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":167,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81779,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":5,"postageNet":6.05,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81780,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":5.9073},"totalGross":33.13,"totalNet":40.0873},"type":"dropshipment","userId":14718},{"channelId":1,"clientData":{"abbreviation":"JS","company":"Propellor","dateOfBirth":"","debtorId":"753953","email":"julielarue@propellor.eu","firstName":"Jullien","fullName":"Jullien Serres","gender":"M","id":14718,"lastName":"Serres","login":"julielarue@propellor.eu","middleName":"","mobile":"06-12345678","phone":"020-6717171","ssn":"","title":"","vatNumber":""},"date":"2022-02-25T19:04:27","debtorId":"753953","email":"","externalId":"","extraInfo":"","firstName":"Julien","id":169,"invoiceData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"w.spies@propel.us","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81793,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"","numberExtension":"","phone":"+31206717171","postalCode":"7323 KE","region":"","street":"Mazurkastraat 20","type":"invoice","url":""}},"itemCount":2,"language":"EN-US","lastName":"Serres","middleName":"","paymentData":{"grossAmount":0,"netAmount":0,"payMethod":"","payStatus":"","paystatusdate":"","tax":0,"taxPercentage":21,"transactionId":""},"postageData":{"carrier":"","partialDeliveryAllowed":"Y","postage":0,"postageNet":0,"postageTaxPercentage":21,"requestDate":"","shippingMethod":""},"reference":"","remarks":"","shippingData":{"address":{"active":"Y","city":"Apeldoorn","code":"","company":"","country":"NL","email":"","fax":"","firstName":"Julien","gender":"U","icp":"N","id":81794,"isDefault":"N","lastName":"Serres","middleName":"","mobile":"","name":"","notes":"","number":"20","numberExtension":"","phone":"","postalCode":"7323 KE","region":"","street":"Mazurkastraat","type":"delivery","url":""}},"shopId":1,"source":"intern","status":"CONFIRMED","total":{"discountPercentage":0,"discountValue":0,"tax":{"21":23.31},"totalGross":111,"totalNet":134.31},"type":"dropshipment","userId":14718}],"messages":[],"total":5}},"Search Orders - 200 (no results)":{"value":{"data":[],"messages":[],"total":0}}}}}},"400":{"description":"Search Orders - 400 (invalid fieldname)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"317"}},"date":{"schema":{"type":"string","example":"Mon, 28 Feb 2022 17:08:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"426a69e6-4f30-49fa-b10a-1629a9394182"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [extraStatus] is not permitted"},"example":["#: extraneous key [extraStatus] is not permitted","#: required key [exported] not found","#: required key [externalOrderNumber] not found","#: required key [status] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Orders - 400 (invalid fieldname)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [extraStatus] is not permitted","#: required key [exported] not found","#: required key [externalOrderNumber] not found","#: required key [status] not found"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Usergroups

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-usergroups.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Usergroups"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/usergroups/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The usergroups search endpoint is only available on the Propeller cloud version. 
  

Retrieves a list of usergroups by using the search fields below. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `dateCreated` | [DateFilter](#date-filter) |
| `dateModified` | [DateFilter](#date-filter) |
| `offset` | integer |
| `page` | integer |

## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for usergroups like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"name":{"type":"string","example":"Sander"},"offset":{"type":"number","example":12},"page":{"type":"number","example":1}}},"examples":{"Search Usergroups":{"value":{"dateCreated":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"name":"Sander","offset":12,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Usergroups - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"4374"}},"date":{"schema":{"type":"string","example":"Wed, 30 Aug 2023 10:33:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"52f3bb33-25b9-4ee5-9dfb-0d08f829a9ba"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"authorizeId":{"type":"string","example":""},"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"Y"},"company":{"type":"string","example":"Propellor Sonar Root"},"dateCreated":{"type":"string","example":"2017-10-10T15:39:26"},"dateModified":{"type":"string","example":"2023-03-22T12:01:39"},"defaultobjectId":{"type":"number","example":0},"department":{"type":"string","example":""},"id":{"type":"number","example":102},"inheritOrderList":{"type":"string","example":"Y"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Propellor Sonar Root"},"notes":{"type":"string","example":""},"office":{"type":"string","example":""},"orderListAllowAll":{"type":"string","example":"U"},"orderListManagerId":{"type":"string","example":""},"userManagerId":{"type":"string","example":""}}},"example":[{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Propellor Sonar Root","dateCreated":"2017-10-10T15:39:26","dateModified":"2023-03-22T12:01:39","defaultobjectId":0,"department":"","id":102,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Root","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-10T15:39:26","dateModified":"2023-03-22T12:01:39","defaultobjectId":100052,"department":"","id":103,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Propellor","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Propellor Sonar ROOT","dateCreated":"2017-10-10T15:52:05","dateModified":"2023-03-22T12:01:39","defaultobjectId":228955,"department":"","id":106,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar ROOT","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-18T17:10:00","dateModified":"2023-03-22T12:01:39","defaultobjectId":227050,"department":"","id":107,"inheritOrderList":"Y","inheritProductList":"Y","name":"Nieuwsbrief 2","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-20T13:44:49","dateModified":"2023-03-22T12:01:39","defaultobjectId":199539,"department":"","id":108,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Vestigingen","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Trimergo","dateCreated":"2017-10-24T10:32:51","dateModified":"2023-03-22T12:01:39","defaultobjectId":227298,"department":"","id":109,"inheritOrderList":"Y","inheritProductList":"Y","name":"Customer root","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-24T10:33:11","dateModified":"2023-03-22T12:01:39","defaultobjectId":476428,"department":"","id":110,"inheritOrderList":"Y","inheritProductList":"Y","name":"Particulier","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":"200008"},{"authorizeId":"","budget":"N","budgetInherit":"N","company":"","dateCreated":"2017-10-24T10:34:36","dateModified":"2023-03-22T12:01:39","defaultobjectId":201073,"department":"","id":111,"inheritOrderList":"Y","inheritProductList":"Y","name":"Zakelijk","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-11-07T10:57:19","dateModified":"2023-03-22T12:01:39","defaultobjectId":227128,"department":"","id":112,"inheritOrderList":"Y","inheritProductList":"Y","name":"Temp","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-11-07T11:01:36","dateModified":"2023-03-22T12:01:39","defaultobjectId":200942,"department":"","id":113,"inheritOrderList":"Y","inheritProductList":"Y","name":"Onderwijs","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"200008","budget":"N","budgetInherit":"N","company":"","dateCreated":"2017-12-04T14:43:23","dateModified":"2023-03-22T12:01:39","defaultobjectId":200007,"department":"","id":114,"inheritOrderList":"Y","inheritProductList":"Y","name":"Bestellers","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":"200008"},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2018-02-05T13:19:50","dateModified":"2023-03-22T12:01:39","defaultobjectId":200036,"department":"","id":115,"inheritOrderList":"Y","inheritProductList":"Y","name":"System","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""}]},"end":{"type":"number","example":12},"itemsFound":{"type":"number","example":107},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":9},"start":{"type":"number","example":1},"total":{"type":"number","example":12}}},"examples":{"Search Usergroups - 200":{"value":{"data":[{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Propellor Sonar Root","dateCreated":"2017-10-10T15:39:26","dateModified":"2023-03-22T12:01:39","defaultobjectId":0,"department":"","id":102,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Root","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-10T15:39:26","dateModified":"2023-03-22T12:01:39","defaultobjectId":100052,"department":"","id":103,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Propellor","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Propellor Sonar ROOT","dateCreated":"2017-10-10T15:52:05","dateModified":"2023-03-22T12:01:39","defaultobjectId":228955,"department":"","id":106,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar ROOT","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-18T17:10:00","dateModified":"2023-03-22T12:01:39","defaultobjectId":227050,"department":"","id":107,"inheritOrderList":"Y","inheritProductList":"Y","name":"Nieuwsbrief 2","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-20T13:44:49","dateModified":"2023-03-22T12:01:39","defaultobjectId":199539,"department":"","id":108,"inheritOrderList":"Y","inheritProductList":"Y","name":"Propellor Sonar Vestigingen","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"Trimergo","dateCreated":"2017-10-24T10:32:51","dateModified":"2023-03-22T12:01:39","defaultobjectId":227298,"department":"","id":109,"inheritOrderList":"Y","inheritProductList":"Y","name":"Customer root","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-10-24T10:33:11","dateModified":"2023-03-22T12:01:39","defaultobjectId":476428,"department":"","id":110,"inheritOrderList":"Y","inheritProductList":"Y","name":"Particulier","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":"200008"},{"authorizeId":"","budget":"N","budgetInherit":"N","company":"","dateCreated":"2017-10-24T10:34:36","dateModified":"2023-03-22T12:01:39","defaultobjectId":201073,"department":"","id":111,"inheritOrderList":"Y","inheritProductList":"Y","name":"Zakelijk","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-11-07T10:57:19","dateModified":"2023-03-22T12:01:39","defaultobjectId":227128,"department":"","id":112,"inheritOrderList":"Y","inheritProductList":"Y","name":"Temp","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2017-11-07T11:01:36","dateModified":"2023-03-22T12:01:39","defaultobjectId":200942,"department":"","id":113,"inheritOrderList":"Y","inheritProductList":"Y","name":"Onderwijs","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""},{"authorizeId":"200008","budget":"N","budgetInherit":"N","company":"","dateCreated":"2017-12-04T14:43:23","dateModified":"2023-03-22T12:01:39","defaultobjectId":200007,"department":"","id":114,"inheritOrderList":"Y","inheritProductList":"Y","name":"Bestellers","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":"200008"},{"authorizeId":"","budget":"N","budgetInherit":"Y","company":"","dateCreated":"2018-02-05T13:19:50","dateModified":"2023-03-22T12:01:39","defaultobjectId":200036,"department":"","id":115,"inheritOrderList":"Y","inheritProductList":"Y","name":"System","notes":"","office":"","orderListAllowAll":"U","orderListManagerId":"","userManagerId":""}],"end":12,"itemsFound":107,"messages":["Completed"],"offset":12,"page":1,"pages":9,"start":1,"total":12}}}}}},"400":{"description":"Search Usergroups - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 22 Aug 2023 08:31:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"991f5cfe-9880-4959-bc5c-3aa2fc2d678e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Usergroups - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Search Users

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/search-users.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Search Users"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/users/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



&gt; The users search endpoint is only available on the Propeller cloud version. 
  

Retrieves a list of users by using the search fields below. Results will be [paginated](/reference/legacy/rest-v1/api-reference#pagination).

| **Field** | **Type** |
| --- | --- |
| `debtorIds` | array(string) |
| `dateCreated` | [DateFilter](#date-filter) |
| `dateModified` | [DateFilter](#date-filter) |
| `offset` | integer |
| `page` | integer |

## Date filter

A date filter is a special date search object that can search through a range:

```json
{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}
```

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"expands","in":"query","schema":{"type":"string","example":"sources"},"description":"Use `expands` as a query parameter to fetch additional information for users like sources, parent, etc.\n`sources`: if the \"expands\" parameter contains this value, the response from the API will return additional source information describing where this resource is imported from. If there are no sources for this resource then the `sources` property in the response will be just an empty array."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"dateModified":{"type":"object","properties":{"from":{"type":"string","example":"2020-12-12T00:00:00"},"to":{"type":"string","example":"2023-12-12T00:00:00"}}},"name":{"type":"string","example":"Sander"},"offset":{"type":"number","example":12},"page":{"type":"number","example":1}}},"examples":{"Search Users":{"value":{"dateCreated":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"dateModified":{"from":"2020-12-12T00:00:00","to":"2023-12-12T00:00:00"},"name":"Sander","offset":12,"page":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Search Users - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"2691"}},"date":{"schema":{"type":"string","example":"Wed, 30 Aug 2023 10:30:04 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"8f5dfb64-8541-4928-9fd2-5ba9104cb276"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"cocNumber":{"type":"string","example":""},"company":{"type":"string","example":""},"dateCreated":{"type":"string","example":"2023-05-12T20:07:04"},"dateModified":{"type":"string","example":"2023-05-12T20:07:03"},"dateOfBirth":{"type":"string","example":"August, 28 1993 00:00:00 +0000"},"debtorId":{"type":"string","example":"12345"},"email":{"type":"string","example":"miles@propel.us"},"fax":{"type":"string","example":""},"firstName":{"type":"string","example":"Miles"},"fullName":{"type":"string","example":"Miles McCoy"},"gender":{"type":"string","example":"M"},"iban":{"type":"string","example":""},"id":{"type":"number","example":25474},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"phone":{"type":"string","example":"0032445888"},"pricelistAmount":{"type":"string","example":""},"pricelistPercentage":{"type":"string","example":""},"primaryLanguage":{"type":"string","example":"EN"},"ssn":{"type":"string","example":""},"taxNumber":{"type":"string","example":""},"title":{"type":"string","example":"Mr."}}},"example":[{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-05-12T20:07:04","dateModified":"2023-05-12T20:07:03","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25474,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:18:56","dateModified":"2023-07-14T20:18:55","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25515,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:19:28","dateModified":"2023-07-14T20:19:27","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"1.miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25516,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:19:46","dateModified":"2023-07-14T20:19:46","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us.com","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25517,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:21:01","dateModified":"2023-07-14T20:21:00","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us.com","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25518,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."}]},"end":{"type":"number","example":5},"itemsFound":{"type":"number","example":5},"messages":{"type":"array","items":{"type":"string","example":"Completed"},"example":["Completed"]},"offset":{"type":"number","example":12},"page":{"type":"number","example":1},"pages":{"type":"number","example":1},"start":{"type":"number","example":1},"total":{"type":"number","example":5}}},"examples":{"Search Users - 200":{"value":{"data":[{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-05-12T20:07:04","dateModified":"2023-05-12T20:07:03","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25474,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:18:56","dateModified":"2023-07-14T20:18:55","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25515,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:19:28","dateModified":"2023-07-14T20:19:27","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"1.miles@propel.us","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25516,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:19:46","dateModified":"2023-07-14T20:19:46","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us.com","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25517,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."},{"abbreviation":"MM","cocNumber":"","company":"","dateCreated":"2023-07-14T20:21:01","dateModified":"2023-07-14T20:21:00","dateOfBirth":"August, 28 1993 00:00:00 +0000","debtorId":"12345","email":"miles@propel.us.com","fax":"","firstName":"Miles","fullName":"Miles McCoy","gender":"M","iban":"","id":25518,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","phone":"0032445888","pricelistAmount":"","pricelistPercentage":"","primaryLanguage":"EN","ssn":"","taxNumber":"","title":"Mr."}],"end":5,"itemsFound":5,"messages":["Completed"],"offset":12,"page":1,"pages":1,"start":1,"total":5}}}}}},"400":{"description":"Search Users - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Tue, 22 Aug 2023 08:11:52 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"af1085fc-0046-4a42-8dd8-530b5fbe81b7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Search Users - 400":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}}}}
>
  
</StatusCodes>

---

## Update attribute by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-attribute-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update attribute by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/attributes/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint enables updating the definition of an attribute. The attribute is identified by it's Propeller Id or name. The `attributeClass` Query Param is useful to use when the same attribute name is used for an attribute with a different class.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"attributeClass","in":"query","schema":{"type":"string","example":"product"},"description":"Attribute class. Optional. Used in combination with lookup key `name`. Possible values are `product`, `category`, `user`"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Use `id` or `name`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"668"},"description":"The `id` or `name` of the attribute"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"value":{"type":"array","items":{},"example":[]}}},"examples":{"Update attribute by lookup key":{"value":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":[]}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update attribute by Id - 200 / Update attribute by name and class - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"242"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:19:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7e399cb8-ddff-4a1f-a0ef-04edaec18600"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Kleur"}}},"example":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}]},"group":{"type":"string","example":""},"id":{"type":"number","example":668},"isHidden":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true},"isSearchable":{"type":"boolean","example":false},"isSystem":{"type":"boolean","example":false},"value":{"type":"string","example":""}}},"messages":{"type":"array","items":{"type":"string","example":"Attribute updated"},"example":["Attribute updated"]},"total":{"type":"number","example":1}}},"examples":{"Update attribute by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":""},"messages":["Attribute updated"],"total":1}},"Update attribute by name and class - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Kleur"},{"language":"EN","value":"Color"}],"group":"","id":668,"isHidden":false,"isPublic":true,"isSearchable":false,"isSystem":false,"value":""},"messages":["Attribute updated"],"total":1}}}}}},"400":{"description":"Update attribute by name and class - 400 (invalid value)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"188"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:21:13 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6863900a-d410-4a30-a829-05e448ded69c"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14005},"messages":{"type":"array","items":{"type":"string","example":"Invalid value provided. Attribute type is [enum]."},"example":["Invalid value provided. Attribute type is [enum]."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14005"},"status":{"type":"number","example":400},"type":{"type":"string","example":"AttributeInvalidValue"}}}}},"examples":{"Update attribute by name and class - 400 (invalid value)":{"value":{"error":{"code":14005,"messages":["Invalid value provided. Attribute type is [enum]."],"moreInfo":"https://www.propel.us/docs/errors/14005","status":400,"type":"AttributeInvalidValue"}}}}}}},"404":{"description":"Update attribute by Id - 404 / Update attribute by name and class - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"203"}},"date":{"schema":{"type":"string","example":"Mon, 07 Mar 2022 16:20:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7dd29b63-5541-460b-9826-fadae75be9be"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":14001},"messages":{"type":"array","items":{"type":"string","example":"Attribute with id [800] not found."},"example":["Attribute with id [800] not found."]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/14001"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AttributeNotFound"}}}}},"examples":{"Update attribute by Id - 404":{"value":{"error":{"code":14001,"messages":["Attribute with id [800] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}},"Update attribute by name and class - 404":{"value":{"error":{"code":14001,"messages":["Attribute with name [COLOR] and attributeClass [category] not found."],"moreInfo":"https://www.propel.us/docs/errors/14001","status":404,"type":"AttributeNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Category by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-category-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Category by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/categories/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"REST-API"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the category"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#category-lookup-keys) about category lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"1772"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"examples":{"Update Category by lookup key":{"value":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Category by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"350"}},"date":{"schema":{"type":"string","example":"Wed, 30 Mar 2022 12:49:05 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"27bfbfa7-8497-4486-92c3-8c0aa9ebb958"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"id":{"type":"number","example":1771},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1320}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Fiets"}}},"example":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"020000"}}},"messages":{"type":"array","items":{"type":"string","example":"Category updated"},"example":["Category updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Category by Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"id":1771,"names":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"parent":{"id":1320},"shortDescriptions":[{"language":"NL","value":"Fiets"},{"language":"EN","value":"Bike"}],"source":"REST-API","sourceId":"020000"},"messages":["Category updated"],"total":1}}}}}},"404":{"description":"Update Category by source id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"174"}},"date":{"schema":{"type":"string","example":"Wed, 30 Mar 2022 12:50:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"203f32e5-5475-4605-b89d-cacd6f366d32"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":30006},"messages":{"type":"array","items":{"type":"string","example":"Category with sourceId [17712] not found"},"example":["Category with sourceId [17712] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/30006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CategoryNotFound"}}}}},"examples":{"Update Category by source id - 404":{"value":{"error":{"code":30006,"messages":["Category with sourceId [17712] not found"],"moreInfo":"https://www.propel.us/docs/errors/30006","status":404,"type":"CategoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Cluster by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-cluster-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Cluster by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a single cluster.

## Fields

| **Name** | **Required** |
| --- | --- |
| `names` | no |
| `descriptions` | no |
| `shortDescriptions` | no |
| `language` | no |
| `parent` | no |
| `sourceId` | no |
| `source` | only when `sourceId` is provided |
| `clusterConfigId` | no |
| `code` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"212"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"151203000"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}]},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203000"}}},"examples":{"Update Cluster by lookup key":{"value":{"clusterConfigId":11,"code":"151203000","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}],"names":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"parent":{"id":23409},"shortDescriptions":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"source":"REST-API","sourceId":"151203000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Cluster by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"760"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:41:14 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bf84a8e8-8aea-4192-99b9-65fffca284ff"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"clusterConfigId":{"type":"number","example":11},"code":{"type":"string","example":"151203000"},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}]},"id":{"type":"number","example":210},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":23409}}},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster updated"},"example":["Cluster updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Cluster by lookup key - 200":{"value":{"data":{"clusterConfigId":11,"code":"151203000","descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."},{"language":"EN","value":"Ballpoint pens with ViscoGlide technology. Combines the advantages of a ballpoint pen and a gel pen. Available in medium (1mm.) and XB (1.4mm.) point."}],"id":210,"names":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"parent":{"id":23409},"shortDescriptions":[{"language":"NL","value":"Balpen Slider XB extra"},{"language":"EN","value":"Pen Slider XB extra"}],"source":"REST-API","sourceId":"151203000"},"messages":["Cluster updated"],"total":1}}}}}},"404":{"description":"Update Cluster by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"164"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 09:41:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"91909ffd-bd9d-47b5-a243-bad30af291a9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Cluster with id [211] not found"},"example":["Cluster with id [211] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterNotFound"}}}}},"examples":{"Update Cluster by lookup key - 404":{"value":{"error":{"code":20006,"messages":["Cluster with id [211] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"ClusterNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Cluster Config Setting

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-cluster-config-setting.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Cluster Config Setting"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clustersconfig/{lookupKey}/{lookupValue}/settings/{settingId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.

## Fields

| **Name** | **Required** |
| --- | --- |
| `displayType` | no |
| `priority` | no |

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#clusterconfig-lookup-keys) about cluster config lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"11"},"description":"The value of the key (id or name)"},{"name":"settingId","in":"path","required":true,"schema":{"type":"string","example":"116"},"description":"The id of cluster config setting"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"displayType":{"type":"string","example":"radio"}}},"examples":{"Update Cluster Config Setting":{"value":{"displayType":"radio"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Cluster Config Setting - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Content-Length":{"schema":{"type":"string","example":"99"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 11:59:41 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a73fa162-0f96-41c0-bb43-2bb3eb744100"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"displayType":{"type":"string","example":"radio"},"id":{"type":"number","example":116}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Config Setting updated"},"example":["Cluster Config Setting updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Cluster Config Setting - 200":{"value":{"data":{"displayType":"radio","id":116},"messages":["Cluster Config Setting updated"],"total":1}}}}}},"404":{"description":"Update Cluster Config Setting - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Fri, 27 Oct 2023 12:00:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"0aa2856c-2fd5-4a52-8444-c532e5ba8ecf"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":21007},"messages":{"type":"array","items":{"type":"string","example":"Cluster config setting with id [117] not found"},"example":["Cluster config setting with id [117] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/21007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterConfigSettingNotFound"}}}}},"examples":{"Update Cluster Config Setting - 404":{"value":{"error":{"code":21007,"messages":["Cluster config setting with id [117] not found"],"moreInfo":"https://www.propel.us/docs/errors/21007","status":404,"type":"ClusterConfigSettingNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Company Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-company-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Company Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/companies/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a company address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"9482"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106078"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"},"town":{"type":"string","example":"Amsterdam"}}},"examples":{"Update Company Address":{"value":{"firstName":"Miles","lastName":"McCoy","town":"Amsterdam"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Company Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"104"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:11:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b91a8648-82c9-4758-b713-cbb6c6d070f8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":106076},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Company Address - 200":{"value":{"data":{"firstName":"Miles","id":106076,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Company Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:13:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"2e3defbe-90f4-4671-9a82-27acd949ff12"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [town] is not permitted"},"example":["#: extraneous key [town] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Company Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [town] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Company Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"198"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 16:12:31 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"db28d417-3832-4182-b707-ae08089fe01b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":90006},"messages":{"type":"array","items":{"type":"string","example":"Address with id [106276] not found for [Companies] with id [9482]"},"example":["Address with id [106276] not found for [Companies] with id [9482]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/90006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"AddressNotFound"}}}}},"examples":{"Update Company Address - 404":{"value":{"error":{"code":90006,"messages":["Address with id [106276] not found for [Companies] with id [9482]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Company by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-company-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Company by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/companies/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update company by lookup key. If multiple companies with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the company (e.g. `source` and `language` for lookup key `sourceId`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#company-lookup-keys) about company lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"646"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"company":{"type":"string","example":"Propellor B.V."},"debtorId":{"type":"string","example":"75564998"},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Propellor B.V."},"notes":{"type":"string","example":"Company created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":106}}},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"examples":{"Update Company by lookup key":{"value":{"budget":"N","budgetInherit":"N","cocNumber":"75564998","company":"Propellor B.V.","debtorId":"75564998","department":"","inheritOrderList":"N","inheritProductList":"Y","name":"Propellor B.V.","notes":"Company created from API","office":"","parent":{"id":106},"taxNumber":"NL860325386B01"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Company by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"303"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:23:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"032d03c1-4699-4316-b567-f0e65bb962a0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"cocNumber":{"type":"string","example":"75564998"},"debtorId":{"type":"string","example":"75564998"},"department":{"type":"string","example":""},"id":{"type":"number","example":9482},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Propellor B.V."},"notes":{"type":"string","example":"Company created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":106}}},"taxNumber":{"type":"string","example":"NL860325386B01"}}},"messages":{"type":"array","items":{"type":"string","example":"Company updated"},"example":["Company updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Company by lookup key - 200":{"value":{"data":{"budget":"N","budgetInherit":"N","cocNumber":"75564998","debtorId":"75564998","department":"","id":9482,"inheritOrderList":"N","inheritProductList":"Y","name":"Propellor B.V.","notes":"Company created from API","office":"","parent":{"id":106},"taxNumber":"NL860325386B01"},"messages":["Company updated"],"total":1}}}}}},"400":{"description":"Update Company by lookup key - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:24:07 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"8a5757bf-03e6-4d19-bbe2-f9e32884d18a"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [company] is not permitted"},"example":["#: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Company by lookup key - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Company by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"165"}},"date":{"schema":{"type":"string","example":"Mon, 22 May 2023 15:24:56 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"093d51a4-4d04-4743-8345-5b4cade4fefc"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":40006},"messages":{"type":"array","items":{"type":"string","example":"Company with id [9484] not found"},"example":["Company with id [9484] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/40006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CompanyNotFound"}}}}},"examples":{"Update Company by lookup key - 404":{"value":{"error":{"code":40006,"messages":["Company with id [9484] not found"],"moreInfo":"https://www.propel.us/docs/errors/40006","status":404,"type":"CompanyNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Contact by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-contact-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Contact by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/contacts/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update contact by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. `source` and `language` for lookup key `sourceId`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#contact-lookup-keys) about contact lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25493"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"company":{"type":"string","example":"Propeller"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":9482}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Update Contact by lookup key":{"value":{"abbreviation":"MM","company":"Propeller","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","lastName":"McCoy","middleName":"","mobile":"0038975648","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"NL","source":"REST-API","sourceId":3002196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Contact by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"359"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:40:37 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"264605d0-dd65-41a2-9d1d-1e95b88fd0fe"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25492},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":9482}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"Contact updated"},"example":["Contact updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Contact by lookup key - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25492,"lastName":"McCoy","middleName":"","mobile":"0038975648","parent":{"id":9482},"phone":"0032445888","primaryLanguage":"NL","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["Contact updated"],"total":1}}}}}},"400":{"description":"Update Contact by lookup key - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"187"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:41:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"20ded3dd-be0f-4cca-a4e5-1c30109b8404"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [company] is not permitted"},"example":["#: extraneous key [company] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Contact by lookup key - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [company] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Contact by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"166"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 09:41:19 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c4db7bd1-a3ae-4625-8a05-4690650befea"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":50006},"messages":{"type":"array","items":{"type":"string","example":"Contact with id [25493] not found"},"example":["Contact with id [25493] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/50006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ContactNotFound"}}}}},"examples":{"Update Contact by lookup key - 404":{"value":{"error":{"code":50006,"messages":["Contact with id [25493] not found"],"moreInfo":"https://www.propel.us/docs/errors/50006","status":404,"type":"ContactNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Customer Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-customer-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Customer Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/customers/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a customer address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25494"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"106098"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"isDefault":{"type":"string","example":"U"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Update Customer Address":{"value":{"firstName":"Miles","isDefault":"U","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Customer Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"104"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:38:55 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"bbbae33c-23d4-4194-9b4b-28effc897548"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":106099},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Customer Address - 200":{"value":{"data":{"firstName":"Miles","id":106099,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Customer Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"183"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:40:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"801abe57-ebd3-4476-ba67-8b214b38db70"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#/isDefault: U is not a valid enum value"},"example":["#/isDefault: U is not a valid enum value"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Customer Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#/isDefault: U is not a valid enum value"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Customer Address - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"192"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 12:39:39 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"c408859d-b14a-41f0-ac03-f759d97e1ac0"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Customer] with id [25496] not found"},"example":["Parent resource [Customer] with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentCustomerNotFound"}}}}},"examples":{"Update Customer Address - 404":{"value":{"error":{"code":60007,"messages":["Parent resource [Customer] with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60007","status":404,"type":"ParentCustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Customer by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-customer-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Customer by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/customers/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update customer by lookup key. If multiple customers with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the customer (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#customer-lookup-keys) about customer lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"25495"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Update Customer by lookup key":{"value":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","lastName":"McCoy","middleName":"","mobile":"0038975648","parent":{"id":109},"phone":"0032445888","primaryLanguage":"NL","source":"REST-API","sourceId":3002196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Customer by lookup key - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"359"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:45:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"760355b1-1ec2-421f-ac5c-a9fd61a17e2e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":25494},"lastName":{"type":"string","example":"McCoy"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":109}}},"phone":{"type":"string","example":"0032445888"},"primaryLanguage":{"type":"string","example":"NL"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"Customer updated"},"example":["Customer updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Customer by lookup key - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":25494,"lastName":"McCoy","middleName":"","mobile":"0038975648","parent":{"id":109},"phone":"0032445888","primaryLanguage":"NL","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["Customer updated"],"total":1}}}}}},"400":{"description":"Update Customer by lookup key - 400 (invalid lookup key)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:45:48 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"290bd3ef-cb21-4dc3-bd27-688dffa3cae7"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Update Customer by lookup key - 400 (invalid lookup key)":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Update Customer by lookup key - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"168"}},"date":{"schema":{"type":"string","example":"Tue, 23 May 2023 11:45:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"b7b1ce52-8d92-4702-90e4-9a25c957f5ef"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":60006},"messages":{"type":"array","items":{"type":"string","example":"Customer with id [25496] not found"},"example":["Customer with id [25496] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/60006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"CustomerNotFound"}}}}},"examples":{"Update Customer by lookup key - 404":{"value":{"error":{"code":60006,"messages":["Customer with id [25496] not found"],"moreInfo":"https://www.propel.us/docs/errors/60006","status":404,"type":"CustomerNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Inventory by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-inventory-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Inventory by Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/inventory/id/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint enables updating inventory record by it's unique id.

### Available update fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `costPrice` (integer) | no |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

`warehouseId` and `location` cannot be updated.

If product stock is moved to a different warehouse or location, old inventory record should be updated with 0 quantity, then create a new record with the new warehouseId and/or location

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"16142"},"description":"Inventory record Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":25.5},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":20}}},"examples":{"Update Inventory by Id":{"value":{"costPrice":25.5,"nextDeliveryDate":"2022-02-20T00:00:00","notes":"","quantity":20}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Inventory by Id - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"339"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 19:33:14 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":25.5},"dateModified":{"type":"string","example":"2023-10-02T19:33:14"},"id":{"type":"number","example":16141},"location":{"type":"string","example":"B45"},"nextDeliveryDate":{"type":"string","example":"2022-02-20T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":227237},"quantity":{"type":"number","example":20},"sku":{"type":"string","example":"NCABD70004"},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"usergroupId":{"type":"number","example":143},"warehouseId":{"type":"number","example":0}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Inventory by Id - 200":{"value":{"data":{"companyId":0,"costPrice":25.5,"dateModified":"2023-10-02T19:33:14","id":16141,"location":"B45","nextDeliveryDate":"2022-02-20T00:00:00","notes":"","productId":227237,"quantity":20,"sku":"NCABD70004","supplier":"TECHDATA","supplierCode":"NCABD70004","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Inventory by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"378"}},"date":{"schema":{"type":"string","example":"Thu, 10 Mar 2022 15:31:35 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"e0322069-5ccc-4942-94a3-51f1477fa9c4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":13006},"messages":{"type":"array","items":{"type":"string","example":"Inventory with id [58991] not found"},"example":["Inventory with id [58991] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/13006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"InventoryNotFound"}}}}},"examples":{"Update Inventory by Id - 404":{"value":{"error":{"code":13006,"messages":["Inventory with id [58991] not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Link by Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-link-by-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Link by Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/links/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a link by Id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"485377"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"priority1":{"type":"number","example":1}}},"examples":{"Update Link by Id":{"value":{"isActive":true,"isDefault":true,"priority1":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Link by Id 202","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"96"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:58:41 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"isActive":{"type":"boolean","example":true},"isDefault":{"type":"boolean","example":true},"priority":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Link updated"},"example":["Link updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Link by Id 202":{"value":{"data":{"isActive":true,"isDefault":true,"priority":1},"messages":["Link updated"],"total":1}}}}}},"400":{"description":"Update Link by Id - 400 (invalid schema)","headers":{"Connection":{"schema":{"type":"string","example":"close"}},"Content-Length":{"schema":{"type":"string","example":"189"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:59:21 GMT"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [priority1] is not permitted"},"example":["#: extraneous key [priority1] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Link by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [priority1] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Link by Id - 404","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"161"}},"Date":{"schema":{"type":"string","example":"Tue, 27 Sep 2022 14:58:59 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":18003},"messages":{"type":"array","items":{"type":"string","example":"Link with id [731085] not found"},"example":["Link with id [731085] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/18003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"LinkNotFound"}}}}},"examples":{"Update Link by Id - 404":{"value":{"error":{"code":18003,"messages":["Link with id [731085] not found"],"moreInfo":"https://www.propel.us/docs/errors/18003","status":404,"type":"LinkNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Option by Cluster lookup key and Option Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-option-by-cluster-lookup-key-and-option-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Option by Cluster lookup key and Option Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}/options/{optionId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update single cluster option by cluster lookup key and option id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"215"},"description":"The value of option id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"isRequired":{"type":"boolean","example":false},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"examples":{"Update Option by Cluster lookup key and Option Id":{"value":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"isRequired":false,"names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Option by Cluster lookup key and Option Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"276"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:41:26 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"3fef8739-98a1-494e-9ab0-4b426d518c82"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"id":{"type":"number","example":214},"isRequired":{"type":"string","example":"N"},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Muis"}}},"example":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}]},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"K72334000"}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option updated"},"example":["Cluster Option updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Option by Cluster lookup key and Option Id - 200":{"value":{"data":{"descriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"id":214,"isRequired":"N","names":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"shortDescriptions":[{"language":"NL","value":"Muis"},{"language":"EN","value":"Mouse"}],"source":"REST-API","sourceId":"K72334000"},"messages":["Cluster Option updated"],"total":1}}}}}},"404":{"description":"Update Option by Cluster lookup key and Option Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"207"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 13:41:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"f10955ac-b7aa-4dda-a09e-ec30174ef4da"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20010},"messages":{"type":"array","items":{"type":"string","example":"Cluster Option with id [216] not found for the cluster with id [213]"},"example":["Cluster Option with id [216] not found for the cluster with id [213]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20010"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterOptionNotFound"}}}}},"examples":{"Update Option by Cluster lookup key and Option Id - 404":{"value":{"error":{"code":20010,"messages":["Cluster Option with id [216] not found for the cluster with id [213]"],"moreInfo":"https://www.propel.us/docs/errors/20010","status":404,"type":"ClusterOptionNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Order Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-order-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Order Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/orders/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update an order address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Use `id` or `externalId`"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"195"},"description":"The `id` or `externalId` of the order"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81902"},"description":"Address Id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"postalCode":{"type":"string","example":"7323 KE"}}},"examples":{"Update Order Address":{"value":{"postalCode":"7323 KE"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Order Address - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"90"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:28:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"7eed9828-53e0-4a69-9d32-301874cdc022"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"number","example":81902},"postalCode":{"type":"string","example":"7323 KE"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Order Address - 200":{"value":{"data":{"id":81902,"postalCode":"7323 KE"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Order Address - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"191"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:30:36 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d524d2ed-1e19-4ac3-a033-4417e0382d05"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [postalCodes] is not permitted"},"example":["#: extraneous key [postalCodes] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Order Address - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [postalCodes] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Order Address - 404 (order not found) / Update Order Address - 404 (address not found)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"194"}},"date":{"schema":{"type":"string","example":"Thu, 21 Apr 2022 12:32:43 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ea4c8715-cbc3-46c9-bdc8-22db40ebe4ad"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":15003},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Order] with id [295] not found"},"example":["Parent resource [Order] with id [295] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/15003"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentOrderNotFound"}}}}},"examples":{"Update Order Address - 404 (address not found)":{"value":{"error":{"code":90006,"messages":["Address with id [819021] not found for [Orders] with id [195]"],"moreInfo":"https://www.propel.us/docs/errors/90006","status":404,"type":"AddressNotFound"}}},"Update Order Address - 404 (order not found)":{"value":{"error":{"code":15003,"messages":["Parent resource [Order] with id [295] not found"],"moreInfo":"https://www.propel.us/docs/errors/15003","status":404,"type":"ParentOrderNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product by Cluster lookup key and Product Id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-product-by-cluster-lookup-key-and-product-id.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product by Cluster lookup key and Product Id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/clusters/{lookupKey}/{lookupValue}/products/{productId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update single cluster product details by cluster lookup key and product id.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#cluster-lookup-keys) about cluster lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"210"},"description":"The value of the key (id or sourceId)"},{"name":"productId","in":"path","required":true,"schema":{"type":"string","example":"707968"},"description":"The value of product id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":0.99},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Update Product by Cluster lookup key and Product Id":{"value":{"costPrice":0.99,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product by Cluster lookup key and Product Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"959"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:32:47 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"a3453129-9e07-4719-bf59-54d0f736fc0d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":0.99},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"eanCode":{"type":"string","example":"4004675044075"},"id":{"type":"number","example":707966},"manufacturer":{"type":"string","example":"SCHNEIDER"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpen Slider XB extra blauw"}}},"example":[{"language":"NL","value":"Balpen Slider XB extra blauw"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"blawn"}}},"example":[{"language":"NL","value":"blawn"}]},"oemCode":{"type":"string","example":"151203"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"}]},"price":{"type":"number","example":1.49},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}}},"example":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}]},"shortName":{"type":"string","example":"Balpen Slider XB extra blauw"},"sku":{"type":"string","example":"151203"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"string","example":"151203"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":1.49},"supplier":{"type":"string","example":"REST-API"},"supplierCode":{"type":"string","example":"151203"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product updated"},"example":["Cluster Product updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product by Cluster lookup key and Product Id - 200":{"value":{"data":{"costPrice":0.99,"descriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"eanCode":"4004675044075","id":707966,"manufacturer":"SCHNEIDER","minimumQuantity":1,"names":[{"language":"NL","value":"Balpen Slider XB extra blauw"}],"notes":[{"language":"NL","value":"blawn"}],"oemCode":"151203","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"}],"price":1.49,"shortDescriptions":[{"language":"NL","value":"Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."}],"shortName":"Balpen Slider XB extra blauw","sku":"151203","source":"REST-API","sourceId":"151203","status":"A","suggestedPrice":1.49,"supplier":"REST-API","supplierCode":"151203","taxCode":"H","unit":1},"messages":["Cluster Product updated"],"total":1}}}}}},"404":{"description":"Update Product by Cluster lookup key and Product Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"212"}},"date":{"schema":{"type":"string","example":"Tue, 31 Oct 2023 11:33:10 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"x-request-id":{"schema":{"type":"string","example":"fb7cb47a-19b8-4ddd-9610-208d4e363be3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20013},"messages":{"type":"array","items":{"type":"string","example":"Cluster Product with id [707968] not found for the cluster with id [210]"},"example":["Cluster Product with id [707968] not found for the cluster with id [210]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20013"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ClusterProductNotFound"}}}}},"examples":{"Update Product by Cluster lookup key and Product Id - 404":{"value":{"error":{"code":20013,"messages":["Cluster Product with id [707968] not found for the cluster with id [210]"],"moreInfo":"https://www.propel.us/docs/errors/20013","status":404,"type":"ClusterProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-product-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update product by lookup key. If multiple products with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the product (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"source","in":"query","schema":{"type":"string","example":"TECHDATA"},"description":"Optional. Used in combination with lookup key `sourceId`"},{"name":"language","in":"query","schema":{"type":"string","example":"NL"},"description":"Optional. Default language of the product"},{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#product-lookup-keys) about product lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"40360"},"description":"The value of the key (id, sourceId, sku or supplierCode)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"examples":{"Update Product by lookup key":{"value":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"2842"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:44:15 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"5706c871-1334-4255-8b48-b3c7bedf4b11"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"costPrice":{"type":"number","example":400.95},"descriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}]},"eanCode":{"type":"string","example":"0753759256289"},"id":{"type":"number","example":40360},"manufacturer":{"type":"string","example":"Garmin"},"minimumQuantity":{"type":"number","example":1},"names":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"notes":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Edge 1030 FietsComputer"}}},"example":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}]},"oemCode":{"type":"string","example":"NCABD70004"},"package":{"type":"string","example":"STK"},"packageDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"Stuks"}}},"example":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}]},"parent":{"type":"object","properties":{"id":{"type":"number","example":1202}}},"price":{"type":"number","example":599.95},"shortDescriptions":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string","example":"NL"},"value":{"type":"string","example":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."}}},"example":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}]},"shortName":{"type":"string","example":"Edge 1030 FietsComputer"},"sku":{"type":"string","example":"NCABD70004"},"source":{"type":"string","example":"TECHDATA"},"sourceId":{"type":"string","example":"NCABD70004"},"status":{"type":"string","example":"A"},"suggestedPrice":{"type":"number","example":580},"supplier":{"type":"string","example":"TECHDATA"},"supplierCode":{"type":"string","example":"NCABD70004"},"taxCode":{"type":"string","example":"H"},"unit":{"type":"number","example":1}}},"messages":{"type":"array","items":{"type":"string","example":"Product updated"},"example":["Product updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product by Id - 200":{"value":{"data":{"costPrice":400.95,"descriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."}],"eanCode":"0753759256289","id":40360,"manufacturer":"Garmin","minimumQuantity":1,"names":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"notes":[{"language":"NL","value":"Edge 1030 FietsComputer"},{"language":"EN","value":"Edge 1030 Bike computer"}],"oemCode":"NCABD70004","package":"STK","packageDescriptions":[{"language":"NL","value":"Stuks"},{"language":"EN","value":"Pieces"}],"parent":{"id":1202},"price":599.95,"shortDescriptions":[{"language":"NL","value":"De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."},{"language":"EN","value":"The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."}],"shortName":"Edge 1030 FietsComputer","sku":"NCABD70004","source":"TECHDATA","sourceId":"NCABD70004","status":"A","suggestedPrice":580,"supplier":"TECHDATA","supplierCode":"NCABD70004","taxCode":"H","unit":1},"messages":["Product updated"],"total":1}}}}}},"400":{"description":"Update Product by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"184"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:45:30 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"f0b68a32-00b9-42ac-9c7e-bccbf48fef35"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [name] is not permitted"},"example":["#: extraneous key [name] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Product by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [name] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Product by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"167"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 16:46:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"fdad0066-9b0d-4ea6-b84b-2e681cbfe8e9"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [481189] not found"},"example":["Product with id [481189] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product by Id - 404":{"value":{"error":{"code":80006,"messages":["Product with id [481189] not found"],"moreInfo":"https://www.propel.us/docs/errors/80006","status":404,"type":"ProductNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product Local Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-product-local-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product Local Inventory"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupkey}/{key}/inventory/local"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows updating local inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

Inventory will be updated if record is found, matching on: **product sku**, **warehouseId** and **location.** Error is thrown if record can't be found.

Fields w**arehouseId** and **location** can't be updated, used only to find the correct inventory record.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":3},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Update Product Local Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","quantity":3,"usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product Local Inventory - 200 / Update Product Local Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"332"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 16:05:26 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T10:46:50"},"id":{"type":"number","example":16162},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":3},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"INTERN"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product Local Inventory - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T10:46:50","id":16162,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"INTERN","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory updated"],"total":1}},"Update Product Local Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T16:05:26","id":16148,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":227235,"quantity":3,"sku":"9789006953374","supplier":"INTERN","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Product Local Inventory - 404 / Update Product Local Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 10:48:08 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"0d50b38a-3911-4141-8ecc-06cabbdb216f"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product Local Inventory - 404":{"value":{"error":{"code":13006,"messages":["Inventory record not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Product Supplier Inventory

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-product-supplier-inventory.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Product Supplier Inventory"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/products/{lookupkey}/{key}/inventory/supplier"}
  context={"endpoint"}
>
  
</MethodEndpoint>



This endpoint allows updating supplier inventory data for a product based on a lookup key.

### Available fields

| **Name** | **Required** |
| --- | --- |
| `quantity` (integer) | no |
| `supplier` (string) | no  <br />Default value is product supplier |
| `warehouseId` (integer) | no  <br />Default value is 0 |
| `company` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `usergroup` ([InventoryCompanyUsergroupResource](/reference/legacy/rest-v1/create-product-supplier-inventory#inventorycompanyusergroup-resource)) | `no` |
| `location` (string) | no  <br />Default value is empty |
| `costPrice` (integer) | no  <br />Default value is product costprice |
| `nextDeliveryDate` (date) | no |
| `notes` (string) | no |

`dateModified` is always updated with the current date and time.

Inventory will be updated if record is found, matching on: **product supplierCode**, **supplier, warehouseId** and **location.** Error is thrown if record can't be found.

Fields **supplier**, w**arehouseId** and **location** can't be updated, used only to find the correct inventory record.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupkey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Available lookup keys: id, sourceId, sku, supplierCode"},{"name":"key","in":"path","required":true,"schema":{"type":"string","example":"38952"},"description":"Lookup key value"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"number","example":11.31},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"quantity":{"type":"number","example":3},"supplier":{"type":"string","example":"KERRIDGE"},"usergroup":{"type":"object","properties":{"id":{"type":"number","example":143}}}}},"examples":{"Update Product Supplier Inventory":{"value":{"costPrice":11.31,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","quantity":3,"supplier":"KERRIDGE","usergroup":{"id":143}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Product Supplier Inventory - 200 / Update Product Supplier Inventory for a usergroup - 200","headers":{"Connection":{"schema":{"type":"string","example":"keep-alive"}},"Content-Length":{"schema":{"type":"string","example":"334"}},"Date":{"schema":{"type":"string","example":"Mon, 02 Oct 2023 16:07:01 GMT"}},"Keep-Alive":{"schema":{"type":"string","example":"timeout=20"}},"Return-Format":{"schema":{"type":"string","example":"json"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"number","example":0},"costPrice":{"type":"number","example":11.31},"dateModified":{"type":"string","example":"2022-03-11T10:49:07"},"id":{"type":"number","example":16152},"location":{"type":"string","example":"L5"},"nextDeliveryDate":{"type":"string","example":"2022-02-15T00:00:00"},"notes":{"type":"string","example":""},"productId":{"type":"number","example":38952},"quantity":{"type":"number","example":3},"sku":{"type":"string","example":"AA 0635613"},"supplier":{"type":"string","example":"KERRIDGE"},"supplierCode":{"type":"string","example":"AA 0635613"},"usergroupId":{"type":"number","example":0},"warehouseId":{"type":"number","example":4}}},"messages":{"type":"array","items":{"type":"string","example":"Inventory updated"},"example":["Inventory updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Product Supplier Inventory - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2022-03-11T10:49:07","id":16152,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":38952,"quantity":3,"sku":"AA 0635613","supplier":"KERRIDGE","supplierCode":"AA 0635613","usergroupId":0,"warehouseId":4},"messages":["Inventory updated"],"total":1}},"Update Product Supplier Inventory for a usergroup - 200":{"value":{"data":{"companyId":0,"costPrice":11.31,"dateModified":"2023-10-02T16:07:01","id":16146,"location":"L5","nextDeliveryDate":"2022-02-15T00:00:00","notes":"","productId":227235,"quantity":3,"sku":"9789006953374","supplier":"KERRIDGE","supplierCode":"","usergroupId":143,"warehouseId":0},"messages":["Inventory updated"],"total":1}}}}}},"404":{"description":"Update Product Supplier Inventory - 404 / Update Product Supplier Inventory - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"161"}},"date":{"schema":{"type":"string","example":"Fri, 11 Mar 2022 10:50:02 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"36e60fe2-7c1e-45d0-afce-7cd9cb774de3"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":80006},"messages":{"type":"array","items":{"type":"string","example":"Product with id [98952] not found"},"example":["Product with id [98952] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/80006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ProductNotFound"}}}}},"examples":{"Update Product Supplier Inventory - 404":{"value":{"error":{"code":13006,"messages":["Inventory record not found"],"moreInfo":"https://www.propel.us/docs/errors/13006","status":404,"type":"InventoryNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update User Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-user-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update User Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/users/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a user address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14760"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstNames":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Update User Address":{"value":{"firstNames":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update User Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"103"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 19:12:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"820885e1-1675-4bf5-a07b-f418962b891d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":81908},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update User Address by Id - 200":{"value":{"data":{"firstName":"Miles","id":81908,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update User Address by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"190"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6c032004-3b98-412d-b4ae-bd732ffb4748"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [firstNames] is not permitted"},"example":["#: extraneous key [firstNames] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update User Address by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [firstNames] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update User Address by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [User] with id [147601] not found"},"example":["Parent resource [User] with id [147601] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUserNotFound"}}}}},"examples":{"Update User Address by Id - 404":{"value":{"error":{"code":70007,"messages":["Parent resource [User] with id [147601] not found"],"moreInfo":"https://www.propel.us/docs/errors/70007","status":404,"type":"ParentUserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update User by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-user-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update User by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/users/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update user by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#user-lookup-keys) about user lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"14699"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"examples":{"Update User by lookup key":{"value":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update User by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"322"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:35:38 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"9da109f0-cf0f-488c-a33f-0394aa0ea289"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"abbreviation":{"type":"string","example":"MM"},"dateOfBirth":{"type":"string","example":"28/08/1993"},"debtorId":{"type":"number","example":12345},"email":{"type":"string","example":"miles@propel.us"},"firstName":{"type":"string","example":"Miles"},"gender":{"type":"string","example":"M"},"id":{"type":"number","example":14760},"lastName":{"type":"string","example":"McCoy"},"login":{"type":"string","example":"miles@propel.us"},"middleName":{"type":"string","example":""},"mobile":{"type":"string","example":"0038975648"},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}},"phone":{"type":"string","example":"0032445888"},"source":{"type":"string","example":"REST-API"},"sourceId":{"type":"number","example":3002196},"title":{"type":"string","example":"Mr."}}},"messages":{"type":"array","items":{"type":"string","example":"User updated"},"example":["User updated"]},"total":{"type":"number","example":1}}},"examples":{"Update User by Id - 200":{"value":{"data":{"abbreviation":"MM","dateOfBirth":"28/08/1993","debtorId":12345,"email":"miles@propel.us","firstName":"Miles","gender":"M","id":14760,"lastName":"McCoy","login":"miles@propel.us","middleName":"","mobile":"0038975648","parent":{"id":119},"phone":"0032445888","source":"REST-API","sourceId":3002196,"title":"Mr."},"messages":["User updated"],"total":1}}}}}},"400":{"description":"Update User by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"219"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:36:40 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"d3892a5c-aa92-44de-8c5f-a972a1ca734e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Update User by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Update User by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"162"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 16:36:03 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"39d5e568-9da4-48b0-8c75-6639d95c1a70"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":70006},"messages":{"type":"array","items":{"type":"string","example":"User with id [1476036] not found"},"example":["User with id [1476036] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/70006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UserNotFound"}}}}},"examples":{"Update User by Id - 404":{"value":{"error":{"code":70006,"messages":["User with id [1476036] not found"],"moreInfo":"https://www.propel.us/docs/errors/70006","status":404,"type":"UserNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Usergroup Address

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-usergroup-address.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Usergroup Address"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/usergroups/{lookupKey}/{lookupValue}/addresses/{addressId}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update a usergroup address. The address is identified by `id`.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"122"},"description":"The value of the key (id or sourceId)"},{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"81918"},"description":"Address id"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"firstNames":{"type":"string","example":"Miles"},"lastName":{"type":"string","example":"McCoy"}}},"examples":{"Update Usergroup Address":{"value":{"firstNames":"Miles","lastName":"McCoy"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Usergroup Address by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"clear"}},"content-length":{"schema":{"type":"string","example":"103"}},"date":{"schema":{"type":"string","example":"Mon, 21 Mar 2022 19:12:27 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"820885e1-1675-4bf5-a07b-f418962b891d"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"firstName":{"type":"string","example":"Miles"},"id":{"type":"number","example":81918},"lastName":{"type":"string","example":"McCoy"}}},"messages":{"type":"array","items":{"type":"string","example":"Address updated"},"example":["Address updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Usergroup Address by Id - 200":{"value":{"data":{"firstName":"Miles","id":81918,"lastName":"McCoy"},"messages":["Address updated"],"total":1}}}}}},"400":{"description":"Update Usergroup Address by Id - 400 (invalid schema)","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"190"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:49 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"6c032004-3b98-412d-b4ae-bd732ffb4748"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10007},"messages":{"type":"array","items":{"type":"string","example":"#: extraneous key [firstNames] is not permitted"},"example":["#: extraneous key [firstNames] is not permitted"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10007"},"status":{"type":"number","example":400},"type":{"type":"string","example":"SchemaValidationException"}}}}},"examples":{"Update Usergroup Address by Id - 400 (invalid schema)":{"value":{"error":{"code":10007,"messages":["#: extraneous key [firstNames] is not permitted"],"moreInfo":"https://www.propel.us/docs/errors/10007","status":400,"type":"SchemaValidationException"}}}}}}},"404":{"description":"Update Usergroup Address by Id - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"185"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 18:25:06 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"ca307bd2-10cd-4551-a516-3b9f702fe1a6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20007},"messages":{"type":"array","items":{"type":"string","example":"Parent resource [Usergroup] with id [12256] not found"},"example":["Parent resource [Usergroup] with id [12256] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20007"},"status":{"type":"number","example":404},"type":{"type":"string","example":"ParentUsergroupNotFound"}}}}},"examples":{"Update Usergroup Address by Id - 404":{"value":{"error":{"code":20007,"messages":["Parent resource [Usergroup] with id [12256] not found"],"moreInfo":"https://www.propel.us/docs/errors/20007","status":404,"type":"ParentUsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Update Usergroup by lookup key

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/update-usergroup-by-lookup-key.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update Usergroup by lookup key"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/usergroups/{lookupKey}/{lookupValue}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Use this endpoint to update usergroup by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. `source` and `language` for lookup key `source`).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"lookupKey","in":"path","required":true,"schema":{"type":"string","example":"id"},"description":"Lookup key. Read [more](#usergroup-lookup-keys) about usergroup lookup keys"},{"name":"lookupValue","in":"path","required":true,"schema":{"type":"string","example":"213"},"description":"The value of the key (id or sourceId)"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"examples":{"Update Usergroup by lookup key":{"value":{"budget":"N","budgetInherit":"N","company":"","department":"","inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Update Usergroup by Id - 200","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"264"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:25:57 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"21ad3351-2544-4e19-aef2-f01cc4a8e717"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"budget":{"type":"string","example":"N"},"budgetInherit":{"type":"string","example":"N"},"company":{"type":"string","example":""},"department":{"type":"string","example":""},"id":{"type":"number","example":213},"inheritOrderList":{"type":"string","example":"N"},"inheritProductList":{"type":"string","example":"Y"},"name":{"type":"string","example":"Netherlands"},"notes":{"type":"string","example":"Usergroup created from API"},"office":{"type":"string","example":""},"parent":{"type":"object","properties":{"id":{"type":"number","example":119}}}}},"messages":{"type":"array","items":{"type":"string","example":"Usergroup updated"},"example":["Usergroup updated"]},"total":{"type":"number","example":1}}},"examples":{"Update Usergroup by Id - 200":{"value":{"data":{"budget":"N","budgetInherit":"N","company":"","department":"","id":213,"inheritOrderList":"N","inheritProductList":"Y","name":"Netherlands","notes":"Usergroup created from API","office":"","parent":{"id":119}},"messages":["Usergroup updated"],"total":1}}}}}},"400":{"description":"Update Usergroup by Id - 400","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"220"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:24:24 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"43fe9d1b-48cf-4880-b5b7-e92423f3deb6"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":10006},"messages":{"type":"array","items":{"type":"string","example":"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"},"example":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/10006"},"status":{"type":"number","example":400},"type":{"type":"string","example":"InvalidLookupKey"}}}}},"examples":{"Update Usergroup by Id - 400":{"value":{"error":{"code":10006,"messages":["Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"],"moreInfo":"https://www.propel.us/docs/errors/10006","status":400,"type":"InvalidLookupKey"}}}}}}},"404":{"description":"Update Usergroup byid - 404","headers":{"Alt-Svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"Via":{"schema":{"type":"string","example":"1.1 google, 1.1 google"}},"alt-svc":{"schema":{"type":"string","example":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}},"content-length":{"schema":{"type":"string","example":"170"}},"date":{"schema":{"type":"string","example":"Wed, 20 Apr 2022 21:26:33 GMT"}},"return-format":{"schema":{"type":"string","example":"json"}},"server":{"schema":{"type":"string","example":"istio-envoy"}},"x-request-id":{"schema":{"type":"string","example":"b9a1f56f-f834-48fb-92ec-15385c2bee0b"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"number","example":20006},"messages":{"type":"array","items":{"type":"string","example":"Usergroup with id [21317] not found"},"example":["Usergroup with id [21317] not found"]},"moreInfo":{"type":"string","example":"https://www.propel.us/docs/errors/20006"},"status":{"type":"number","example":404},"type":{"type":"string","example":"UsergroupNotFound"}}}}},"examples":{"Update Usergroup byid - 404":{"value":{"error":{"code":20006,"messages":["Usergroup with id [21317] not found"],"moreInfo":"https://www.propel.us/docs/errors/20006","status":404,"type":"UsergroupNotFound"}}}}}}}}}
>
  
</StatusCodes>

---

## Usergroups

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/usergroups.tag

<LegacyBanner />



Usergroups are used to group users or other usergroups together. This parent - child relationship i.e. tree organizational structure is very powerful because it allows inheriting settings, permissions, pricing, etc. A usergroup can even represent a company in a B2B environment, although this concept will soon be deprecated and a dedicated `Companies` resource will be introduced.

## Usergroup Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `usergroup` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `name` | Usergroup name | string |
| `language` | Default system language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with `source` |
| `company` | Company | string |
| `department` | Department | string |
| `office` | Office | string |
| `notes` | Notes | string |
| `inheritProductList` | Indicates whether pricing should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `inheritOrderList` | Indicates whether the order list should be inherited from the parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `budget` | Usergroup budget settings | enum  <br />  <br />`Y` = Users in usergroup use budget and may only order products within budget  <br />  <br />`H` = Users in usergroup use budget and may also order products outside budget  <br />  <br />`N` = Users in usergroup do not use budgets |
| `budgetInherit` | Indicates whether budget settings should be inherited from parent usergroup | enum  <br />  <br />`Y` = Yes  <br />`N` = No |
| `orderListAllowAll` | Order list settings | enum  <br />  <br />`N` = Order everything within the order list  <br />`Y` = Order everything outside the order list  <br />`A` = Order everything, but products outside the order list must be authorized  <br />`U` = Order everything  <br />`P` = Order restricted products |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## Usergroup Errors

This section describes error codes specific for the `Usergroup` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `20004` | UsergroupExists | 400 | Usergroup already exists | Usergroup with such lookup key already exists |
| `20005` | UsergroupMultipleFound | 400 | Multuple usergroups found. Please provide additional filters | Multiple usergroups with such lookup key exist |
| `20006` | UsergroupNotFound | 404 | Usergroup does not exist | Usergroup with such lookup key not found |
| `20007` | ParentUsergroupNotFound | 404 | Parent usergroup not found | Parent usergroup with such lookup key not found. This error is typical when working with usergroup sub-resources (e.g. attributes, addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | Usergroup address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Users

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/users.tag

<LegacyBanner />



Users represent data about a specific customer. Carts, orders, attributes, addresses are associated with users.

In a B2C environment a user is the actual customer ordering products, in a B2B environment a user is often part of a `usergroup` representing the organisation he/she is working for. Orders in a B2B environment are still placed by a specific user but connected to the organisation by a single `debtorId`which is associated with the user.

## User Lookup keys

| **Key** | **Type** | **Description** |
| --- | --- | --- |
| `id` | integer | Propeller `user` id |
| `sourceId` | string | External system unique id. sourceId should be combined with source |

[What are lookup keys?](/reference/legacy/rest-v1/api-reference#lookup-keys)

## Fields

| **Name** | **Description** | **Type** |
| --- | --- | --- |
| `debtorId` | A unique id representing this user. A debtorId can be automatically generated by Propellor | integer  <br />string  <br /> |
| `firstName` | User first name | string |
| `middleName` | User middle name | string |
| `lastName` | User last name | string |
| `fullName` | User full name | string |
| `title` | User title | string |
| `dateOfBirth` | User date of birth | date |
| `gender` | User gender | enum  <br />  <br />**m**\=Male  <br />**f**\=Female  <br />**u**\=Undefined |
| `login` | Login name used to login to the webshop | string |
| `phone` | User phone number | string |
| `email` | A valid email address | string |
| `company` | Organization the user is working for | string |
| `parent` | Parent usergroup | JSON object that identifies the parent. `id` or `sourceId` in combination with source |
| `pricelistAmount` | A `pricesheet` code in case of special pricing agreements | string |
| `pricelistPercentage` | A `pricesheet` code in case of special pricing agreements | string |
| `taxNumber` | The VAT number of the financial entity this user is part of | `string` |
| `cocNumber` | The chamber of commerce number of the financial entity this user is part of | string |
| `primaryLanguage` | User primary language | string  <br />[ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `sourceId` | External system unique id | string |
| `source` | External system | string |

## User Errors

This section describes error codes specific for the `User` resource.

| **Code** | **Error Type** | **Status Code** | **Message** | **Reason** |
| --- | --- | --- | --- | --- |
| `70004` | UserExists | 400 | User already exists | User with such lookup key already exists |
| `70005` | UserMultipleFound | 400 | Multuple users found. Please provide additional filters | Multiple users with such lookup key exist |
| `70006` | UserNotFound | 404 | User does not exist | User with such lookup key not found |
| `70007` | ParentUserNotFound | 404 | Parent user not found | Parent user with such lookup key not found. This error is typical when working with user sub-resources (e.g. attributes, addresses) |
| `90006` | AddressNotFound | 404 | Address does not exist | User address does not exist |



```mdx-code-block



<DocCardList items={useCurrentSidebarCategory().items}/>
```

---

## Create a new valueset item

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/create-valueset-item.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a new valueset item"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/valuesets/items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new valueset item

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Create valueset item input","content":{"application/json":{"schema":{"type":"object","properties":{"valuesetId":{"type":"number","description":"Valueset id"},"value":{"type":"string","description":"Valueset item unique value"},"descriptions":{"description":"Valueset items descriptions per language","example":[{"language":"NL","value":"Dutch value."},{"language":"DE","value":"German value."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"extra":{"type":"string","description":"Valueset item extra value"}},"required":["valuesetId","value"],"title":"ValuesetItemCreateInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Valueset item created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset item primary identifier","example":12345},"valuesetId":{"type":"integer","description":"Valueset foreign identifier","example":12345},"value":{"type":"string","description":"Valueset item value","maxLength":512,"example":"My valueset item value"},"descriptions":{"description":"Valueset item descriptions","example":[{"lang":"EN","value":"my valueset item description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"extra":{"type":"string","description":"Valueset item extra value","maxLength":512,"example":"My valueset item extra value"}},"required":["id","valuesetId","value","descriptions","extra"],"title":"ValuesetItem"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"409":{"description":"Valueset item already exists"},"500":{"description":"Unknown create valueset item error"}}}
>
  
</StatusCodes>

---

## Create a new valueset

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/create-valueset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a new valueset"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/v1/valuesets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a new valueset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Create valueset input","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Valueset unique name","example":"COUNTRIES"},"descriptions":{"description":"Valueset descriptions per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"type":{"type":"string","description":"The valueset type. SYSTEM types are only created by the system","enum":["SYSTEM","CUSTOM"],"example":"CUSTOM","default":"CUSTOM"}},"required":["name"],"title":"ValuesetCreateInput"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"Valueset created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"409":{"description":"Valuetset already exists"},"500":{"description":"Unknown create valueset error"}}}
>
  
</StatusCodes>

---

## Delete a valueset item by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/delete-valueset-item.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete a valueset item by id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/valuesets/items/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a valueset item by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Valueset item id","schema":{"type":"number"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Valueset item deleted","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Valueset item not found"},"500":{"description":"Unknown delete valueset item error"}}}
>
  
</StatusCodes>

---

## Delete a valueset by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/delete-valueset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Delete a valueset by id"}
>
</Heading>

<MethodEndpoint
  method={"delete"}
  path={"/v1/valuesets/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Delete a valueset by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Valueset id","schema":{"type":"number"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Valueset deleted","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Valueset not found"},"500":{"description":"Unknown delete valueset error"}}}
>
  
</StatusCodes>

---

## Get a valueset by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/get-valueset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get a valueset by id"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/valuesets/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get a valueset by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Valueset identifier","schema":{"type":"number"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Get a valueset by id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Valueset not found"},"500":{"description":"Unknown get valueset error"}}}
>
  
</StatusCodes>

---

## List valueset items

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/list-valueset-items.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List valueset items"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/valuesets/items"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List valueset items

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","required":false,"in":"query","description":"Pagination page number","allowEmptyValue":false,"schema":{"default":1}},{"name":"offset","required":false,"in":"query","description":"Pagination offset number","allowEmptyValue":false,"schema":{"default":12}},{"name":"ids","required":false,"in":"query","description":"List of Valueset items primary identifiers","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"number"}}},{"name":"valuesetIds","required":false,"in":"query","description":"List of Valueset primary identifiers","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"number"}}},{"name":"values","required":false,"in":"query","description":"List of values","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"extras","required":false,"in":"query","description":"List of extra values","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortField","required":false,"in":"query","description":"Field to sort by","allowEmptyValue":false,"schema":{"default":"id","enum":["id","value","extra"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Order option to sort by","allowEmptyValue":false,"schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Paginated list of valueset items","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type Valueset","type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"ValuesetResponse"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"500":{"description":"Unknown list valueset item error"}}}
>
  
</StatusCodes>

---

## List valuesets

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/list-valuesets.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List valuesets"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/v1/valuesets"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List valuesets

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"page","required":false,"in":"query","description":"Pagination page number","allowEmptyValue":false,"schema":{"default":1}},{"name":"offset","required":false,"in":"query","description":"Pagination offset number","allowEmptyValue":false,"schema":{"default":12}},{"name":"createdAtGreaterThan","required":false,"in":"query","description":"Search by date created greater than","allowEmptyValue":false,"example":"2314-03-14T03:14:15.926Z","schema":{"format":"date-time","type":"string"}},{"name":"createdAtLessThan","required":false,"in":"query","description":"Search by date created less than","allowEmptyValue":false,"example":"2314-03-14T03:14:15.926Z","schema":{"format":"date-time","type":"string"}},{"name":"lastModifiedAtGreaterThan","required":false,"in":"query","description":"Search by date updated greater than","allowEmptyValue":false,"example":"2314-03-14T03:14:15.926Z","schema":{"format":"date-time","type":"string"}},{"name":"lastModifiedAtLessThan","required":false,"in":"query","description":"Search by date updated less than","allowEmptyValue":false,"example":"2314-03-14T03:14:15.926Z","schema":{"format":"date-time","type":"string"}},{"name":"ids","required":false,"in":"query","description":"List of Valueset primary identifiers","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"number"}}},{"name":"type","required":false,"in":"query","description":"Valueset type. One of: [SYSTEM, CUSTOM]","allowEmptyValue":false,"schema":{"enum":["SYSTEM","CUSTOM"],"type":"string"}},{"name":"names","required":false,"in":"query","description":"List of names","allowEmptyValue":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sortField","required":false,"in":"query","description":"Field to sort by","allowEmptyValue":false,"schema":{"default":"id","enum":["id","name","lastModifiedAt","createdAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Order option to sort by","allowEmptyValue":false,"schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Paginated list of valuesets","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"List of items of type Valueset","type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}},"itemsFound":{"type":"integer","description":"Total number of items found","minimum":0,"example":12},"offset":{"type":"integer","description":"The amount of items to show per page","nullable":true,"minimum":1,"example":12,"default":12},"page":{"type":"integer","description":"The current page","nullable":true,"minimum":1,"example":4,"default":1},"pages":{"type":"integer","description":"Total amount of pages","nullable":true,"minimum":1,"example":1},"start":{"type":"integer","description":"Start position of the current page","nullable":true,"minimum":1,"example":1},"end":{"type":"integer","description":"End position of the current page","nullable":true,"minimum":1,"example":12}},"required":["items","itemsFound","offset","page","pages","start","end"],"title":"ValuesetResponse"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"500":{"description":"Unknown list valueset error"}}}
>
  
</StatusCodes>

---

## Update a valueset item by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/update-valueset-item.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a valueset item by id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/valuesets/items/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update a valueset item by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Valueset item identifier","schema":{"type":"number"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Update valueset item input","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"Valueset item unique value"},"descriptions":{"description":"Valueset items descriptions per language","example":[{"language":"NL","value":"Dutch value."},{"language":"DE","value":"German value."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}},"extra":{"type":"string","description":"Valueset item extra value"}},"title":"ValuesetItemUpdateDTO"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Valueset item updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset item primary identifier","example":12345},"valuesetId":{"type":"integer","description":"Valueset foreign identifier","example":12345},"value":{"type":"string","description":"Valueset item value","maxLength":512,"example":"My valueset item value"},"descriptions":{"description":"Valueset item descriptions","example":[{"lang":"EN","value":"my valueset item description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"extra":{"type":"string","description":"Valueset item extra value","maxLength":512,"example":"My valueset item extra value"}},"required":["id","valuesetId","value","descriptions","extra"],"title":"ValuesetItem"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Valueset item not found"},"409":{"description":"Valueset item already exists"},"500":{"description":"Unknown update valueset item error"}}}
>
  
</StatusCodes>

---

## Update a valueset by id

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/update-valueset.api

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a valueset by id"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/v1/valuesets/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Update a valueset by id

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","required":true,"in":"path","description":"Valueset identifier","schema":{"type":"number"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"description":"Update valueset input","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Valueset unique name","example":"COUNTRIES"},"descriptions":{"description":"Valueset descriptions per language","example":[{"language":"NL","value":"Dutch desc."},{"language":"DE","value":"German desc."}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Localized field language code","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","nullable":true,"description":"Localized field value","example":"example value"}},"required":["language","value"],"title":"LocalizedStringInput"}}},"title":"ValuesetUpdateDTO"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Valueset updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Valueset primary identifier","example":12345},"name":{"type":"string","description":"Valueset name","maxLength":64,"example":"My valueset name"},"type":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"Valueset type","example":"CUSTOM"},"descriptions":{"description":"Valueset descriptions","example":[{"lang":"EN","value":"my valueset description"}],"type":"array","items":{"type":"object","properties":{"language":{"type":"string","description":"Language is set as 2 character country code.","maxLength":2,"minLength":2,"example":"EN"},"value":{"type":"string","description":"Localized field value","example":"example value"}},"required":["language"],"title":"LocalizedString"}},"lastModifiedBy":{"type":"integer","description":"The userId of the user that changed the valueset"},"lastModifiedAt":{"type":"string","format":"date-time","description":"Valueset last modified date"},"createdBy":{"type":"integer","description":"The userId of the user that created the valueset"},"createdAt":{"type":"string","format":"date-time","description":"Valueset creation date"}},"required":["id","name","type","descriptions","lastModifiedAt","createdAt"],"title":"Valueset"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Valueset not found"},"409":{"description":"Valueset already exists"},"500":{"description":"Unknown update valueset error"}}}
>
  
</StatusCodes>

---

## Valuesets API

URL: https://docs.propeller-commerce.com/reference/legacy/rest-v1/valuesets/valuesets-api.info

<LegacyBanner />


<span
  className={"theme-doc-version-badge badge badge--secondary"}
  children={"Version: 0.3.4"}
>
</span>

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Valuesets API"}
>
</Heading>



Valuesets API

<div
  style={{"marginBottom":"2rem"}}
>
  <Heading
    id={"authentication"}
    as={"h2"}
    className={"openapi-tabs__heading"}
    children={"Authentication"}
  >
  </Heading><SchemaTabs
    className={"openapi-tabs__security-schemes"}
  >
    <TabItem
      label={"OAuth 2.0: OAuth2"}
      value={"OAuth2"}
    >
      
      
      OAuth2 Authorization
      
      <div>
        <table>
          <tbody>
            <tr>
              <th>
                Security Scheme Type:
              </th><td>
                oauth2
              </td>
            </tr><tr>
              <th>
                OAuth Flow (clientCredentials):
              </th><td>
                <div>
                  Token URL: https://api.helice.cloud/oauth2/token/
                </div><span>
                  Scopes:
                </span><ul>
                  
                </ul>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
    </TabItem>
  </SchemaTabs>
</div><div
  style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
  <h3
    style={{"marginBottom":"0.25rem"}}
  >
    Contact
  </h3><span>
    Propeller: [cloud@propel.us](mailto:cloud@propel.us)
  </span><span>
    URL: [https://propeller-commerce.com](https://propeller-commerce.com)
  </span>
</div>

---

## Explorer

URL: https://docs.propeller-commerce.com/reference/rest/explorer

# REST API Explorer

An interactive explorer for testing endpoints against the Propeller REST API. Enter your base URL and access token to start making requests.
<RestApiExplorer />

---

## REST API Reference

URL: https://docs.propeller-commerce.com/reference/rest

# REST API Reference

Complete reference for the Propeller REST API. Use the interactive explorer to test endpoints, or browse the full endpoint listing.

The REST API is the primary interface for integrating Propeller with business systems: ERP, PIM, CRM, PLM and other operational tools. Use it for bulk data operations, syncing and system-to-system communication.

## In this section

- [Explorer](/reference/rest/explorer) — Interactive REST API explorer for testing endpoints
- [Endpoints](/reference/rest/endpoints/authentication) — All endpoints organized by resource, including the [Get Access Token](/reference/rest/endpoints/get-access-token) endpoint

## Machine-readable spec

Download the REST [OpenAPI specs](https://docs.propeller-commerce.com/openapi/index.json), one file per service, for code generation and tooling. Each endpoint page is also available as Markdown, with its request and response schema, by appending `.md` to the endpoint URL.

## Related guides

- [Sources](/integrations/integration-patterns/sources) — Track external system identifiers on resources
- [Lookup Keys](/integrations/integration-patterns/lookup-keys) — Reference resources by different identifier types
- [Pagination](/integrations/integration-patterns/pagination) — Navigate large result sets
- [Directives](/integrations/integration-patterns/directives) — Control create, update and delete behavior in bulk operations
- [Expanding Resources](/integrations/integration-patterns/expanding-resources) — Include related data in API responses
- [Localized Strings](/integrations/integration-patterns/localized-strings) — Work with multi-language text fields
- [B2B and B2C Data Models](/integrations/integration-patterns/b2b-and-b2c) — Companies, contacts and customers
- [Authentication and Security](/integrations/integration-patterns/authentication-and-security) — Token management and retry patterns for production integrations

---

## AccountIconAndMenu

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/account-icon-and-menu

# AccountIconAndMenu

A versatile user account component with two rendering modes: a **dropdown** (header icon + popup menu) and a **sidebar** (always-visible account navigation). Adapts its UI based on authentication state — showing a login form for guests and account navigation for authenticated users.

Supports both **B2B** (`Contact`) and **B2C** (`Customer`) user types from the Propeller Commerce platform.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Dropdown Mode (Header)

The default mode renders a user icon in the header. When clicked, it opens a dropdown that shows either a login form (guest) or account navigation (authenticated).

```tsx



const graphqlClient = new GraphQLClient({
  endpoint: '/api/graphql',
  headers: { 'Content-Type': 'application/json' },
});

function Header() {
  const [user, setUser] = useState(null);
  const router = useRouter();

  return (
    <AccountIconAndMenu
      graphqlClient={graphqlClient}
      user={user}
      afterLogin={(loggedInUser, accessToken, refreshToken) => {
        // Store tokens and update user state
        localStorage.setItem('accessToken', accessToken);
        localStorage.setItem('refreshToken', refreshToken);
        setUser(loggedInUser);
      }}
      onMenuItemClick={(href) => router.push(href)}
      onLogoutClick={() => {
        localStorage.removeItem('accessToken');
        setUser(null);
      }}
      onForgotPasswordClick={() => router.push('/forgot-password')}
      onRegisterClick={() => router.push('/register')}
    />
  );
}
```

### Dropdown with Delegation Mode

If you want to handle authentication yourself (e.g., via a custom API route), use `onLoginSubmit` instead of `graphqlClient`. The component will not call any SDK services — it simply forwards the credentials.

```tsx
<AccountIconAndMenu
  user={user}
  loginLoading={isLoading}
  loginError={errorMessage}
  onLoginSubmit={async (email, password) => {
    setIsLoading(true);
    try {
      const res = await fetch('/api/auth/login', {
        method: 'POST',
        body: JSON.stringify({ email, password }),
      });
      const data = await res.json();
      setUser(data.user);
    } catch (err) {
      setErrorMessage('Invalid credentials');
    } finally {
      setIsLoading(false);
    }
  }}
  onMenuItemClick={(href) => router.push(href)}
  onLogoutClick={() => setUser(null)}
/>
```

### Sidebar Mode (Account Layout)

Renders as an always-visible vertical navigation panel, intended for use in account page layouts. No dropdown toggle or login form — only navigation for authenticated users.

```tsx



function AccountLayout({ children }) {
  const pathname = usePathname();

  return (
    <div className="flex gap-8">
      <aside className="w-64">
        <AccountIconAndMenu
          variant="sidebar"
          user={user}
          currentPath={pathname}
          onMenuItemClick={(href) => router.push(href)}
          onLogoutClick={() => logout()}
          menuLinks={[
            { label: 'Dashboard', href: '/account' },
            { label: 'Orders', href: '/account/orders' },
            { label: 'Addresses', href: '/account/addresses' },
            { label: 'Quotes', href: '/account/quotes' },
            { label: 'Favorites', href: '/account/favorites' },
          ]}
        />
      </aside>
      <main className="flex-1">{children}</main>
    </div>
  );
}
```

### Custom Labels (i18n)

All text in the component can be customized via the `labels` prop, making it suitable for multi-language storefronts.

```tsx
<AccountIconAndMenu
  user={user}
  graphqlClient={graphqlClient}
  labels={{
    accountLabel: 'My Account',
    signedInAs: 'Signed in as',
    logoutLabel: 'Sign Out',
    loginTitle: 'Welcome Back',
    loginButton: 'Sign In',
    email: 'Email Address',
    password: 'Password',
    forgotPassword: 'Forgot your password?',
    registerText: 'No account yet?',
    registerLink: 'Create Account',
  }}
  onMenuItemClick={(href) => router.push(href)}
  onLogoutClick={() => logout()}
/>
```

### Guest Checkout Link

Add a guest checkout option to the login dropdown (useful on cart/checkout pages).

```tsx
<AccountIconAndMenu
  user={null}
  graphqlClient={graphqlClient}
  displayGuestCheckoutLink={true}
  onGuestCheckoutClick={() => router.push('/checkout/guest')}
  labels={{ guestCheckoutLink: 'Continue as Guest' }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you're building a custom account menu instead of using this component, here are the SDK calls and patterns you need:

### Dropdown Mode (Self-Contained Login)

```ts

  GraphQLClient,
  LoginService,
  UserService,
  LoginInput,
  Contact,
  Customer,
} from 'propeller-sdk-v2';

// 1. Initialize the GraphQL client
const graphqlClient = new GraphQLClient({
  endpoint: '/api/graphql',
  headers: { 'Content-Type': 'application/json' },
});

// 2. Check auth state
// Read `accessToken` from localStorage. If present, the user is authenticated.
// If not, show a login form. If yes, show the account navigation menu.

// 3. Login flow
async function login(email: string, password: string) {
  const loginService = new LoginService(graphqlClient);
  const { session } = await loginService.login({ email, password });

  // Store tokens
  localStorage.setItem('accessToken', session.accessToken);
  localStorage.setItem('refreshToken', session.refreshToken);

  // Update client with auth header
  graphqlClient.updateConfig({
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${session.accessToken}`,
    },
  });

  // Fetch user profile
  const userService = new UserService(graphqlClient);
  const user = await userService.getViewer({});

  // Notify other components
  window.dispatchEvent(new CustomEvent('userLoggedIn'));

  return user;
}

// 4. Determine user type
function isB2BUser(user: Contact | Customer): user is Contact {
  return 'company' in user;
}

// 5. Logout
function logout() {
  localStorage.removeItem('accessToken');
  localStorage.removeItem('refreshToken');
  window.dispatchEvent(new CustomEvent('userLoggedOut'));
  // pseudo-code: clear your user state and show the login form
}
```

### Dropdown with Delegation Mode

```ts
// When handling authentication yourself, no SDK calls are needed.
// Simply forward credentials to your custom API:

async function loginWithDelegation(email: string, password: string) {
  const res = await fetch('/api/auth/login', {
    method: 'POST',
    body: JSON.stringify({ email, password }),
  });
  const data = await res.json();
  // Update your user state with data.user
  return data.user;
}
```

### Sidebar Mode

```ts
// Sidebar mode is purely presentational — no SDK calls needed.
// Render an always-visible navigation with menu links.
// Highlight the active link by comparing each link's href against the current route path:
//   - Exact match for '/account'
//   - Prefix match for sub-routes like '/account/orders'
```

Your UI should render:
- **Unauthenticated**: A user icon that opens a dropdown with a login form (email, password, submit button, forgot password link, register link).
- **Authenticated**: A greeting ("Hi, \{firstName\}") that opens a dropdown with account navigation links and a logout button.
- For sidebar mode: always-visible navigation with active link highlighting based on the current route path.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Prop | Type | Default | Description |
|---|---|---|---|
| `user` | `Contact \| Customer \| null` | `null` | Authenticated user object. Shows account menu when present; login form when `null`. |
| `variant` | `'dropdown' \| 'sidebar'` | `'dropdown'` | Render mode. |
| `graphqlClient` | `GraphQLClient` | — | SDK client for self-contained login. When provided (without `onLoginSubmit`), the component handles authentication internally. |
| `currentPath` | `string` | — | Current route path for active link highlighting (sidebar mode). |
| `showAccountMenuOnClick` | `boolean` | `true` | Show dropdown on icon click. If `false`, fires `onAccountIconClick` instead. |
| `accountMenuTitle` | `string` | `'My account'` | Title displayed in the dropdown. |
| `accountHeaderLoginForm` | `boolean` | `true` | Show inline login form in dropdown for unauthenticated users. When `false`, shows a redirect button instead. |
| `menuLinks` | `AccountMenuLink[]` | See below | Account navigation links shown when authenticated. |
| `labels` | `Record<string, string>` | — | Customizable labels (see [Labels](#labels) section). |
| `iconClassName` | `string` | — | Additional CSS class for the icon button. |
| `menuClassName` | `string` | — | Additional CSS class for the dropdown panel. |

### Login Form Props

These props are forwarded to the embedded `LoginForm` component (dropdown mode only).

| Prop | Type | Default | Description |
|---|---|---|---|
| `onLoginSubmit` | `(email: string, password: string) => void` | — | Delegation mode: parent handles authentication. When set, SDK login is disabled. |
| `loginLoading` | `boolean` | `false` | Show loading spinner on login button (delegation mode). |
| `loginError` | `string` | — | Error message to display in the form (delegation mode). |
| `loginFormTitle` | `string` | `'Welcome Back'` | Title inside the login form. |
| `loginFormSubtitle` | `string` | — | Subtitle inside the login form. |
| `loginButtonText` | `string` | `'Log In'` | Login button text. |
| `displayForgotPasswordLink` | `boolean` | `true` | Show forgot password link. |
| `displayRegisterLink` | `boolean` | `true` | Show register link. |
| `displayGuestCheckoutLink` | `boolean` | `false` | Show guest checkout link. |
| `beforeLogin` | `() => void` | — | Called before the login process starts. |
| `afterLogin` | `(user, accessToken?, refreshToken?, expiresAt?) => void` | — | Called after successful self-contained login with user data and tokens. |

### Callback Props

| Prop | Type | Description |
|---|---|---|
| `onAccountIconClick` | `() => void` | Fires when icon is clicked and `showAccountMenuOnClick` is `false`. |
| `onMenuItemClick` | `(href: string) => void` | Fires when a navigation link is clicked. Receives the target path. |
| `onLogoutClick` | `() => void` | Fires when logout button is clicked. |
| `onForgotPasswordClick` | `() => void` | Fires when "Forgot Password" is clicked. |
| `onRegisterClick` | `() => void` | Fires when "Register" is clicked. |
| `onGuestCheckoutClick` | `() => void` | Fires when "Guest Checkout" is clicked. |

### AccountMenuLink

```ts
interface AccountMenuLink {
  label: string;   // Display text
  href: string;    // URL path
  icon?: string;   // Optional icon identifier
}
```

### Default Menu Links

```ts
[
  { label: 'Dashboard', href: '/account' },
  { label: 'Orders', href: '/account/orders' },
  { label: 'Addresses', href: '/account/addresses' },
  { label: 'Quotes', href: '/account/quotes' },
  { label: 'Invoices', href: '/account/invoices' },
  { label: 'Favorites', href: '/account/favorites' },
]
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function Signature

```ts

  GraphQLClient,
  LoginService,
  UserService,
  LoginInput,
  Contact,
  Customer,
} from 'propeller-sdk-v2';

async function login(
  graphqlClient: GraphQLClient,
  email: string,
  password: string
): Promise<Contact | Customer> {
  const loginService = new LoginService(graphqlClient);
  const { session } = await loginService.login({ email, password });
  graphqlClient.updateConfig({
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${session.accessToken}`,
    },
  });
  const userService = new UserService(graphqlClient);
  return await userService.getViewer({});
}
```

### Options Table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `email` | `string` | — | `LoginInput.email` |
| `password` | `string` | — | `LoginInput.password` |

### Callbacks Table

| Callback | When it fires | What to implement |
|---|---|---|
| `afterLogin` | After successful self-contained login | Store tokens (`accessToken`, `refreshToken`) in localStorage. Update user state. |
| `onMenuItemClick` | Navigation link is clicked | Route to the target `href` using your router. |
| `onLogoutClick` | Logout button is clicked | Clear tokens from localStorage. Clear user state. Dispatch `userLoggedOut` event. |
| `onForgotPasswordClick` | "Forgot Password" is clicked | Route to your forgot-password page. |
| `onRegisterClick` | "Register" is clicked | Route to your registration page. |
| `onGuestCheckoutClick` | "Guest Checkout" is clicked | Route to your guest checkout flow. |
| `onAccountIconClick` | Icon clicked when dropdown is disabled | Navigate to account page or open a custom menu. |
| `beforeLogin` | Before the login process starts | Show loading state or perform pre-login validation. |
| `onLoginSubmit` | Login form submitted (delegation mode) | Handle authentication via your own API. No SDK calls are made. |

### UI-Only Props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `variant` — render mode (`'dropdown'` or `'sidebar'`)
- `currentPath` — current route path for active link highlighting
- `showAccountMenuOnClick` — whether to show dropdown on click
- `accountMenuTitle` — dropdown title text
- `accountHeaderLoginForm` — show inline login form vs redirect button
- `menuLinks` — navigation link items
- `labels` — customizable UI strings
- `iconClassName` — CSS class for icon button
- `menuClassName` — CSS class for dropdown panel
- `loginLoading` — loading spinner state
- `loginError` — error message string
- `loginFormTitle` — login form title
- `loginFormSubtitle` — login form subtitle
- `loginButtonText` — login button text
- `displayForgotPasswordLink` — show/hide forgot password link
- `displayRegisterLink` — show/hide register link
- `displayGuestCheckoutLink` — show/hide guest checkout link

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Used in |
|---|---|---|
| `accountLabel` | `'Account'` | Icon button label (unauthenticated) |
| `signedInAs` | `'Signed in as'` | Authenticated user header |
| `logoutLabel` | `'Log Out'` | Logout button text |
| `loginTitle` | `'Welcome Back'` | Login form title |
| `loginSubtitle` | — | Login form subtitle |
| `loginButton` | `'Log In'` | Login button text |
| `email` | `'Email'` | Email input label |
| `emailPlaceholder` | `'name@example.com'` | Email input placeholder |
| `password` | `'Password'` | Password input label |
| `passwordPlaceholder` | `'••••••••'` | Password input placeholder |
| `forgotPassword` | `'Forgot password?'` | Forgot password link |
| `registerText` | `"Don't have an account?"` | Registration prompt |
| `registerLink` | `'Create an Account'` | Register link text |
| `guestCheckoutLink` | `'Continue as Guest'` | Guest checkout link text |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  accountLabel: 'Account',
  signedInAs: 'Signed in as',
  logoutLabel: 'Log Out',
  loginTitle: 'Welcome Back',
  loginSubtitle: '',
  loginButton: 'Log In',
  email: 'Email',
  emailPlaceholder: 'name@example.com',
  password: 'Password',
  passwordPlaceholder: '••••••••',
  forgotPassword: 'Forgot password?',
  registerText: "Don't have an account?",
  registerLink: 'Create an Account',
  guestCheckoutLink: 'Continue as Guest',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Dropdown Mode (default)

- **Unauthenticated**: Shows "Account" label next to a user icon. Clicking opens a dropdown with a login form (email/password fields, login button, forgot password link, register link).
- **Authenticated**: Shows "Hi, \{firstName\}" next to the icon. Dropdown displays user info, navigation links, and a logout button.
- **Click outside**: Dropdown closes automatically when clicking outside the component.
- **Login success**: Dropdown auto-closes and form resets when `user` prop changes from `null` to a user object.

### Sidebar Mode

- Always-visible vertical navigation with "Signed in as" header, menu links, and logout button.
- Active link highlighting based on `currentPath`: exact match for `/account`, prefix match for sub-routes like `/account/orders`.
- No dropdown toggle, click-outside listener, or login form.

### Hydration

Uses an internal mounted guard to prevent server/client rendering mismatches when user data comes from `localStorage`. User-dependent content (name, auth state) only renders after the component has mounted on the client.

### Authentication Flow

When the user submits the login form in self-contained mode, the following sequence occurs:

1. `LoginService.login()` is called with the email and password
2. The returned `accessToken` is injected into the `GraphQLClient` headers as `Authorization: Bearer <token>`
3. `UserService.getViewer()` fetches the full user profile
4. A `userLoggedIn` custom event is dispatched on `window` (for other components to react)
5. The `afterLogin` callback is called with the user object and tokens

```
User submits form
  → LoginService.login({ email, password })
  → graphqlClient.updateConfig({ headers: { Authorization: 'Bearer <token>' } })
  → UserService.getViewer({})
  → window.dispatchEvent(new CustomEvent('userLoggedIn'))
  → afterLogin(user, accessToken, refreshToken, expiresAt)
```

## GraphQL

### Login Mutation

```graphql
mutation Login($input: LoginInput!) {
  login(input: $input) {
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

### Viewer Query

```graphql
query Viewer {
  viewer {
    ... on Contact {
      contactId
      firstName
      lastName
      email
      company {
        companyId
        name
      }
    }
    ... on Customer {
      customerId
      firstName
      lastName
      email
    }
  }
}
```

## SDK Services

In **self-contained mode** (when `graphqlClient` is provided without `onLoginSubmit`), the component uses the following SDK services internally to handle authentication:

### LoginService

Authenticates the user with email and password credentials.

```ts


const loginService = new LoginService(graphqlClient);

const loginInput: LoginInput = {
  email: 'user@example.com',
  password: 'password123',
};

const response = await loginService.login(loginInput);

// Response contains session data:
// response.session.accessToken  — JWT access token
// response.session.refreshToken — refresh token for token renewal
// response.session.expirationTime — token expiry timestamp
```

### UserService

Fetches the authenticated user's profile after login.

```ts


const userService = new UserService(graphqlClient);

// Fetch current viewer (requires valid Authorization header)
const viewer = await userService.getViewer({});

// Returns Contact (B2B) or Customer (B2C) with:
// viewer.firstName, viewer.lastName, viewer.email
// viewer.company (Contact only — B2B company data)
```

---

## AddressCard

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/address-card

# AddressCard

A complete address display and management component that integrates with the Propeller SDK. Renders a structured address card with optional edit, delete, and set-as-default actions. Supports multiple address types (`Address`, `CartAddress`, `WarehouseAddress`, `OrderAddress`) and two form rendering modes: **modal** (default overlay) and **inline** (embedded in page flow).

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Full CRUD on an addresses page

```tsx






const addressService = new AddressService(graphqlClient);
const userService = new UserService(graphqlClient);

function AddressesPage({ addresses }: { addresses: Address[] }) {
  const handleEdit = async (editedAddress: Address) => {
    await addressService.updateAddress({
      id: editedAddress.id,
      input: {
        firstName: editedAddress.firstName,
        lastName: editedAddress.lastName,
        street: editedAddress.street,
        number: editedAddress.number,
        numberExtension: editedAddress.numberExtension,
        postalCode: editedAddress.postalCode,
        city: editedAddress.city,
        country: editedAddress.country,
        email: editedAddress.email,
        phone: editedAddress.phone,
        company: editedAddress.company,
        gender: editedAddress.gender,
        icp: editedAddress.icp,
      },
    });
  };

  const handleDelete = async (address: Address) => {
    await addressService.deleteAddress({ id: address.id });
  };

  const handleSetDefault = async (address: Address) => {
    await userService.setDefaultAddress({ addressId: address.id });
  };

  return (
    <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4">
      {addresses.map((addr) => (
        <AddressCard
          key={addr.id}
          graphqlClient={graphqlClient}
          address={addr}
          countries={countries}
          onEdit={handleEdit}
          afterEdit={() => toast.success('Address updated')}
          onDelete={handleDelete}
          afterDelete={() => toast.success('Address deleted')}
          onSetDefault={handleSetDefault}
          afterSetDefault={() => toast.success('Default address updated')}
        />
      ))}
    </div>
  );
}
```

### Read-only display (order detail page)

```tsx
<AddressCard address={order.invoiceAddress} enableActions={false} />
<AddressCard address={order.deliveryAddress} enableActions={false} />
```

### New address creation (modal)

```tsx
const [showNewForm, setShowNewForm] = useState(false);

{showNewForm && (
  <AddressCard
    graphqlClient={graphqlClient}
    address={null}
    isNew
    addressType="DELIVERY"
    countries={countries}
    onEdit={async (newAddress) => {
      await addressService.createAddress({ input: newAddress });
      await refreshAddresses();
    }}
    onCancel={() => setShowNewForm(false)}
  />
)}
```

### Inline form for checkout

```tsx
<AddressCard
  address={null}
  inline
  isNew
  addressType="INVOICE"
  title="Invoice Address"
  showIcp
  countries={countries}
  onEdit={(addressData) => handleCheckoutAddress(addressData, 'INVOICE')}
/>
```

### Checkout with existing address (logged-in user)

```tsx
<AddressCard
  address={cart.invoiceAddress}
  enableDelete={false}
  enableSetDefault={false}
  countries={countries}
  onEdit={(addressData) => handleAddressSubmit(addressData, 'INVOICE')}
  afterEdit={() => toast.success('Address updated')}
/>
```

### With custom labels (localization)

```tsx
<AddressCard
  address={null}
  inline
  isNew
  addressType="INVOICE"
  countries={countries}
  labels={{
    firstName: 'Voornaam',
    lastName: 'Achternaam',
    street: 'Straat',
    number: 'Huisnr',
    postalCode: 'Postcode',
    city: 'Plaats',
    country: 'Land',
    selectCountry: 'Selecteer land',
    save: 'Opslaan',
    cancel: 'Annuleren',
    newTitle: 'Nieuw adres',
  }}
  onEdit={handleSave}
/>
```

### With async lifecycle hooks

```tsx
<AddressCard
  graphqlClient={graphqlClient}
  address={address}
  countries={countries}
  beforeSave={() => setLoading(true)}
  onEdit={async (editedAddress) => {
    await addressService.updateAddress({ id: editedAddress.id, input: editedAddress });
    await refreshUserData();
  }}
  afterEdit={() => setLoading(false)}
  onDelete={(addr) => addressService.deleteAddress({ id: addr.id })}
  afterDelete={() => toast.success('Address deleted')}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need full control over address management without using the AddressCard component, here is how to set up the SDK services and perform the four key operations.

### Service setup

```ts


const addressService = new AddressService(graphqlClient);
const userService = new UserService(graphqlClient);
```

### Fetch addresses

Addresses are available on the user/contact object returned by `UserService.getViewer()`:

```ts
async function fetchAddresses(): Promise<Address[]> {
  const viewer = await userService.getViewer({});
  return viewer?.addresses || [];
}
```

### Create a new address

```ts
async function createAddress(formData: Record<string, any>) {
  await addressService.createAddress({
    input: {
      type: 'DELIVERY',
      firstName: formData.firstName,
      lastName: formData.lastName,
      street: formData.street,
      number: formData.number,
      numberExtension: formData.numberExtension,
      postalCode: formData.postalCode,
      city: formData.city,
      country: formData.country, // 2-letter ISO code, e.g. 'NL'
      email: formData.email,
      phone: formData.phone,
      company: formData.company,
      gender: formData.gender,
    },
  });
  // pseudo-code: refetch addresses, show success notification
}
```

### Update an existing address

```ts
async function updateAddress(id: number, formData: Record<string, any>) {
  await addressService.updateAddress({
    id,
    input: formData,
  });
  // pseudo-code: refetch addresses, show success notification
}
```

### Delete an address

```ts
async function deleteAddress(id: number) {
  await addressService.deleteAddress({ id });
  // pseudo-code: refetch addresses, show success notification
}
```

### Set as default address

```ts
async function setDefaultAddress(addressId: number) {
  await userService.setDefaultAddress({ addressId });
  // pseudo-code: refetch addresses, show success notification
}
```

### UI notes

Render each address as a card showing: company name, full name with salutation, street + number + extension, postal code + city, and country (resolve the 2-letter code to a full name from a countries list). Show a "Default" badge when `isDefault === 'Y'`. Provide edit, delete, and set-default action buttons on each card. Use a form with fields for gender, company, first name, middle name, last name, street, number, extension, postal code, city, country (dropdown), email, and phone.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | No | -- | GraphQL client instance. Only needed when the parent performs SDK operations in callbacks. Omit for read-only use. |
| `address` | `Address \| CartAddress \| WarehouseAddress \| OrderAddress \| null` | Yes | -- | The address object to display. Pass `null` for new address forms. |
| `countries` | `{ code: string; name: string }[]` | No | -- | Country list for the country dropdown. Each entry has a 2-letter ISO `code` and display `name`. |

### Visibility

All visibility props default to `true`. Pass `false` to hide.

| Prop | Type | Default | Description |
|---|---|---|---|
| `showCompanyName` | `boolean` | `true` | Display company name |
| `showSalutation` | `boolean` | `true` | Display salutation (Mr./Mrs.) in the name line |
| `showFullName` | `boolean` | `true` | Display full name line |
| `showStreet` | `boolean` | `true` | Display street line |
| `showNumberExtension` | `boolean` | `true` | Display house number and extension in street line |
| `showPostalCode` | `boolean` | `true` | Display postal code in city line |
| `showCity` | `boolean` | `true` | Display city in city line |
| `showCountry` | `boolean` | `true` | Display country name |
| `showEmail` | `boolean` | `false` | Display email address |
| `showPhone` | `boolean` | `false` | Display phone number |
| `showIcp` | `boolean` | `false` | Show ICP/ICS (intra-community supply) checkbox in the edit form |

### Actions

| Prop | Type | Default | Description |
|---|---|---|---|
| `enableActions` | `boolean` | `true` | Show the action buttons area (edit, delete, set default) |
| `enableEdit` | `boolean` | `true` | Show Edit button |
| `enableDelete` | `boolean` | `true` | Show Delete button |
| `enableSetDefault` | `boolean` | `true` | Show Set Default button (auto-hidden when address is already default) |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `beforeSave` | `() => void` | Called before any save processing begins |
| `onEdit` | `(address: Address) => void \| Promise<void>` | Called when the user submits the edit form. Receives the full edited address object. Supports async -- the form waits for resolution before closing. |
| `afterEdit` | `(address: Address) => void \| Promise<void>` | Called after `onEdit` completes. Use for notifications, loading state cleanup, etc. |
| `onDelete` | `(address: Address) => void` | Called when the user confirms deletion. Receives the full address object (not just the ID). |
| `afterDelete` | `(address: Address) => void` | Called after `onDelete` completes. Receives the same address object. |
| `onSetDefault` | `(address: Address) => void` | Called when Set Default is clicked. |
| `afterSetDefault` | `(address: Address) => void` | Called after `onSetDefault` completes. |
| `onCancel` | `() => void` | Called when the form is cancelled in `isNew` mode. Use to hide the component or reset parent state. |

### Form configuration

| Prop | Type | Default | Description |
|---|---|---|---|
| `isNew` | `boolean` | `false` | New address mode: auto-opens the edit form on mount, hides the card body, calls `onCancel` on dismiss |
| `inline` | `boolean` | `false` | Render the form inline (embedded in page) instead of in a modal overlay |
| `addressType` | `string` | -- | Address type for new addresses (e.g., `'DELIVERY'`, `'INVOICE'`). Included in the edited address when the address has no existing type. |
| `title` | `string` | -- | Custom title for the form. Falls back to "New Address" (`isNew`) or "Edit Address" |
| `labels` | `Record<string, string>` | `{}` | Custom labels for all form fields, buttons, and titles. See Label Keys below. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signatures

```ts
// AddressService
addressService.createAddress({ input: AddressInput }): Promise<Address>
addressService.updateAddress({ id: number, input: AddressInput }): Promise<Address>
addressService.deleteAddress({ id: number }): Promise<void>

// UserService
userService.setDefaultAddress({ addressId: number }): Promise<Address>
userService.getViewer({}): Promise<Contact | Customer>
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `id` | `number` | *required* (update/delete) | `id` param in `updateAddress` / `deleteAddress` |
| `input.type` | `string` | -- | Address type: `'DELIVERY'`, `'INVOICE'` |
| `input.firstName` | `string` | *required* | First name field |
| `input.lastName` | `string` | *required* | Last name field |
| `input.street` | `string` | *required* | Street name |
| `input.number` | `string` | *required* | House number |
| `input.numberExtension` | `string` | -- | House number extension |
| `input.postalCode` | `string` | *required* | Postal code |
| `input.city` | `string` | *required* | City name |
| `input.country` | `string` | *required* | 2-letter ISO country code (e.g., `'NL'`) |
| `input.email` | `string` | *required* | Email address |
| `input.phone` | `string` | -- | Phone number |
| `input.company` | `string` | -- | Company name |
| `input.gender` | `string` | -- | Gender code: `'M'`, `'F'`, `'U'` |
| `input.icp` | `boolean` | -- | Intra-community supply flag |
| `addressId` | `number` | *required* (set default) | `addressId` param in `setDefaultAddress` |

### Callbacks table

| Callback | Purpose |
|---|---|
| `beforeSave` | Pre-save hook (e.g., show loading state) |
| `onEdit` | Persist the edited address via SDK |
| `afterEdit` | Post-save hook (e.g., show notification, hide loading) |
| `onDelete` | Persist deletion via SDK |
| `afterDelete` | Post-delete hook (e.g., show notification) |
| `onSetDefault` | Set address as default via SDK |
| `afterSetDefault` | Post-set-default hook |
| `onCancel` | Handle form cancellation (e.g., unmount the new-address form) |

### UI-only props (no SDK equivalent)

The following props control visual presentation only and have no SDK counterpart: `showCompanyName`, `showSalutation`, `showFullName`, `showStreet`, `showNumberExtension`, `showPostalCode`, `showCity`, `showCountry`, `showEmail`, `showPhone`, `showIcp`, `enableActions`, `enableEdit`, `enableDelete`, `enableSetDefault`, `inline`, `title`, `className`, `labels`, `countries`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Used for |
|-----|---------|---------|
| `gender` | `'Gender'` | Gender field label |
| `genderMale` | `'Male'` | Male option |
| `genderFemale` | `'Female'` | Female option |
| `genderOther` | `'Other'` | Other option |
| `company` | `'Company'` | Company field label |
| `firstName` | `'First Name'` | First name field label |
| `middleName` | `'Middle Name'` | Middle name field label |
| `lastName` | `'Last Name'` | Last name field label |
| `street` | `'Street'` | Street field label |
| `number` | `'Number'` | House number field label |
| `numberExtension` | `'Ext'` | Number extension field label |
| `postalCode` | `'Postal Code'` | Postal code field label |
| `city` | `'City'` | City field label |
| `country` | `'Country'` | Country field label |
| `selectCountry` | `'Select country'` | Country dropdown placeholder |
| `email` | `'Email'` | Email field label |
| `phone` | `'Phone'` | Phone field label |
| `icp` | `'ICP/ICS (Intra-Community Supply)'` | ICP checkbox label |
| `edit` | `'Edit'` | Edit button text |
| `delete` | `'Delete'` | Delete button text |
| `setDefault` | `'Set Default'` | Set default button text |
| `save` | `'Save'` | Save button text |
| `saving` | `'Saving...'` | Save button text while the form is submitting |
| `cancel` | `'Cancel'` | Cancel button text |
| `newTitle` | `'New Address'` | Form title in new mode |
| `editTitle` | `'Edit Address'` | Form title in edit mode |
| `confirmDeleteTitle` | `'Confirm Delete'` | Delete confirmation dialog title |
| `confirmDeleteMessage` | `'Are you sure you want to delete this address?'` | Delete confirmation dialog message |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  gender: 'Gender',
  genderMale: 'Male',
  genderFemale: 'Female',
  genderOther: 'Other',
  company: 'Company',
  firstName: 'First Name',
  middleName: 'Middle Name',
  lastName: 'Last Name',
  street: 'Street',
  number: 'Number',
  numberExtension: 'Ext',
  postalCode: 'Postal Code',
  city: 'City',
  country: 'Country',
  selectCountry: 'Select country',
  email: 'Email',
  phone: 'Phone',
  icp: 'ICP/ICS (Intra-Community Supply)',
  edit: 'Edit',
  delete: 'Delete',
  setDefault: 'Set Default',
  save: 'Save',
  saving: 'Saving...',
  cancel: 'Cancel',
  newTitle: 'New Address',
  editTitle: 'Edit Address',
  confirmDeleteTitle: 'Confirm Delete',
  confirmDeleteMessage: 'Are you sure you want to delete this address?',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Address Display Structure

The card renders address fields in this order:

1. Company name (bold, large text)
2. Full name with salutation -- Mr./Mrs. prefix based on `gender` field (M/F/U)
3. Street + house number + extension
4. Postal code + city
5. Country (full name resolved from the `countries` list, falls back to the 2-letter code)
6. Email and phone (only when `showEmail` / `showPhone` are `true`)
7. Default badge -- a colored badge reading "Default DELIVERY Address" (or similar) when `isDefault === 'Y'`

### Edit Form

The edit form contains fields for: gender (dropdown), company, first name, middle name, last name, street, house number, number extension, postal code, city, country (dropdown from `countries` prop), email, phone, and optionally ICP/ICS checkbox.

Required fields (enforced by HTML validation): first name, last name, street, number, postal code, city, country, email.

The form can render in two modes controlled by the `inline` prop:
- **Modal** (default): Opens as a centered overlay with backdrop. Includes a close button in the header.
- **Inline**: Renders embedded in the page flow without any overlay. Useful for checkout forms.

### Delete Confirmation Modal

Clicking "Delete" opens a confirmation dialog. The address is only deleted (via `onDelete`) after the user confirms. The dialog text is customizable via `confirmDeleteTitle` and `confirmDeleteMessage` labels.

### isNew Mode

When `isNew` is `true`:
- The address card body is hidden
- The edit form auto-opens on mount
- The "Cancel" button only appears when `onCancel` is provided; clicking it calls the callback (e.g., to unmount the component)
- The `addressType` prop fills the `type` field on the resulting address object

### Optimistic Updates

After the user saves the form, the component immediately updates its internal display using a local state copy of the address (`localAddress`). This provides instant visual feedback while the parent performs the actual API call in `onEdit`. If the API call fails, the parent should handle reverting.

### Double-Submission Prevention

A `saving` flag prevents the form from being submitted multiple times. While a save is in progress, the save and cancel buttons are disabled. The `beforeSave` callback fires after the guard is set but before the address object is constructed.

### Notes Field

The `notes` field is preserved when editing — the existing `notes` value is carried through to the saved address object — but there is **no input field** for it in the form UI. If your use case requires editable notes, build a custom form.

### Country Dropdown

The country dropdown is populated from the `countries` prop -- an array of `{ code: string; name: string }` objects. The `code` is stored as the address's `country` value (2-letter ISO code, e.g., `'NL'`, `'DE'`). The card display resolves the code back to the full country name using `getCountryName()`.

### CartAddress Limitations

`CartAddress` objects typically lack `id`, `isDefault`, and `type` fields. When displaying a `CartAddress`, the delete and set-default actions will gracefully no-op because there is no `id` to act on.

## GraphQL Queries and Mutations

### Create address

```graphql
mutation CreateAddress($input: AddressInput!) {
  addressCreate(input: $input) {
    id
    type
    firstName
    lastName
    street
    number
    numberExtension
    postalCode
    city
    country
    email
    phone
    company
    gender
    isDefault
    icp
  }
}
```

### Update address

```graphql
mutation UpdateAddress($id: Int!, $input: AddressInput!) {
  addressUpdate(id: $id, input: $input) {
    id
    type
    firstName
    lastName
    street
    number
    numberExtension
    postalCode
    city
    country
    email
    phone
    company
    gender
    isDefault
    icp
  }
}
```

### Delete address

```graphql
mutation DeleteAddress($id: Int!) {
  addressDelete(id: $id)
}
```

### Set default address

```graphql
mutation SetDefaultAddress($addressId: Int!) {
  userSetDefaultAddress(addressId: $addressId) {
    id
    isDefault
  }
}
```

## SDK Services

AddressCard delegates persistence to the parent via callbacks. The parent typically uses these `propeller-sdk-v2` services:

### AddressService

Used for creating, updating, and deleting addresses.

```ts


const addressService = new AddressService(graphqlClient);

// Create
await addressService.createAddress({
  input: {
    type: 'DELIVERY',
    firstName: 'Jan',
    lastName: 'de Vries',
    street: 'Keizersgracht',
    number: '100',
    postalCode: '1015AA',
    city: 'Amsterdam',
    country: 'NL',
    email: 'jan@example.com',
  },
});

// Update
await addressService.updateAddress({
  id: 42,
  input: {
    firstName: 'Jan',
    lastName: 'de Vries',
    street: 'Herengracht',
    number: '200',
    postalCode: '1016BS',
    city: 'Amsterdam',
    country: 'NL',
  },
});

// Delete
await addressService.deleteAddress({ id: 42 });
```

### UserService

Used for setting a default address on the user profile.

```ts


const userService = new UserService(graphqlClient);

// Set default address
await userService.setDefaultAddress({ addressId: 42 });
```

## Notes

- `graphqlClient` is optional -- omit it for read-only use cases (order detail, cart sidebar)
- The `onEdit` callback receives the full edited address object including `id`, `type`, `isDefault`, and `icp`
- The country field sends 2-letter ISO codes (e.g., `"NL"`) -- the Propeller GraphQL API requires max 2-character country codes
- The `inline` prop only affects form rendering; the card display is unaffected
- When `inline` is `true` and no address is provided, the form auto-opens on mount (same as `isNew`)

---

## CompanySwitcher

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/company-switcher

# CompanySwitcher

Provides a dropdown selector for B2B users (Contact type) who belong to multiple companies. Displays the currently active company name and lets the user switch between their assigned companies. Designed for use in the site header or navigation bar.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage in Header

```tsx



function Header({ user }: { user: Contact }) {
  const handleCompanyChange = (company: Company) => {
    console.log('Switched to:', company.name, company.companyId);
  };

  return (
    <CompanySwitcher
      user={user}
      onCompanyChange={handleCompanyChange}
    />
  );
}
```

### With CompanyContext integration

The recommended pattern uses `CompanyContext` to persist the selected company across the app and sync it with other components (e.g., OrderList, UserDetails, AddressCard).

```tsx




function Header({ user }: { user: Contact }) {
  const { selectedCompany, setSelectedCompany } = useCompany();

  return (
    <CompanySwitcher
      user={user}
      selectedCompanyId={selectedCompany?.companyId}
      onCompanyChange={setSelectedCompany}
    />
  );
}
```

### Conditional rendering for multi-company contacts only

Only show the switcher when the user is a Contact with more than one company:

```tsx


{state.isAuthenticated && state.user && 'contactId' in state.user
  && (state.user as Contact).companies
  && ((state.user as Contact).companies!.items?.length || 0) > 1 && (
    <CompanySwitcher
      user={state.user as Contact}
      selectedCompanyId={selectedCompany?.companyId}
      onCompanyChange={setSelectedCompany}
    />
  )}
```

### With custom icon

```tsx
<CompanySwitcher
  user={user}
  icon="building"
  onCompanyChange={handleCompanyChange}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Extracting companies from the user object

```ts


function getCompanies(user: Contact): Company[] {
  // The SDK may serialize items under `items` or `_items`
  const raw = user.companies as any;
  const items = (raw?.items ?? raw?._items) as Company[] | undefined;
  if (Array.isArray(items) && items.length > 0) return items;
  return user.company ? [user.company] : [];
}

// Only show the switcher when the user has more than one company
const companies = getCompanies(user);
if (companies.length <= 1) {
  // No switcher needed
}
```

### Handling company selection

```ts
function handleSelect(company: Company) {
  // pseudo-code: update your active company state

  // Persist to localStorage so other components and page reloads can read it
  localStorage.setItem('selected_company', JSON.stringify(company));

  // Notify other components (e.g., OrderList, UserDetails) via custom event
  window.dispatchEvent(new CustomEvent('companySwitched', { detail: company }));
}
```

### Active company resolution

Determine the active company using this priority:

1. The company the user just selected (from your local state)
2. An externally controlled `selectedCompanyId` (e.g., from a shared state provider)
3. `user.company` as the default fallback

### Click-outside dismissal

When the dropdown is open, add a `mousedown` listener on `document` that checks whether the click target is outside the switcher element. If so, close the dropdown. Remove the listener when the dropdown closes.

### Cross-component sync pattern

To persist the selected company across page navigations and sync with other components:

- Store the selected company in `localStorage` (key: `selected_company`) and in your app-level state.
- Dispatch a `companySwitched` custom event on `window` when the selection changes.
- Listen for `userLoggedOut` events to clear the selection on logout.
- Other components (OrderList, UserDetails, etc.) listen for the `companySwitched` event to refetch data for the new company.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required Props

| Prop | Type | Description |
|---|---|---|
| `user` | `Contact` | The authenticated B2B user. Companies are read from `user.companies.items` (or `user.companies._items`). Falls back to `user.company` if no companies list is available. |
| `onCompanyChange` | `(company: Company) => void` | Callback fired when the user selects a different company. Receives the full `Company` object. |

### Optional Props

| Prop | Type | Default | Description |
|---|---|---|---|
| `icon` | `string` | `'default-company-switch-icon'` | CSS icon class identifier. Applied as `icon-{value}` on the trigger button icon span. |
| `selectedCompanyId` | `number` | `undefined` | Externally controlled active company ID. Use this to sync the switcher with a context provider (e.g., `CompanyContext`). When not provided, the component defaults to `user.company`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function companySwitcher(options: CompanySwitcherOptions): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `user` | `Contact` | (required) | `user` prop |
| `onCompanyChange` | `(company: Company) => void` | (required) | `onCompanyChange` prop |
| `selectedCompanyId` | `number` | `undefined` | `selectedCompanyId` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `icon` -- CSS icon class for the trigger button

</TabItem>
</Tabs>

---

## Behavior

### Active company resolution

The component determines the active company using the following priority:

1. **Internal state** (`activeCompanyId`) -- set when the user clicks a company in the dropdown
2. **`selectedCompanyId` prop** -- syncs with external state (e.g., `CompanyContext`)
3. **`user.company`** -- the user's default company from the Propeller API

If no company can be resolved, the trigger button displays "Select company".

### Company list resolution

The component reads the user's companies from `user.companies.items`. Due to SDK serialization behavior, it also checks `user.companies._items` as a fallback. If neither is available or the array is empty, it falls back to a single-item list containing `user.company`.

### Dropdown interaction

- **Open/close**: Clicking the trigger button toggles the dropdown. An animated chevron rotates to indicate open/closed state.
- **Click outside**: Clicking anywhere outside the component closes the dropdown.
- **Selection**: Clicking a company in the list immediately updates the internal state, closes the dropdown, and fires `onCompanyChange`.
- **Active indicator**: The currently active company is shown in bold with a checkmark icon.

### Accessibility

- The trigger button uses `aria-haspopup="listbox"` and `aria-expanded` to communicate dropdown state.
- The dropdown list uses `role="listbox"` with `role="option"` and `aria-selected` on each item.
- The trigger has `aria-label="Switch company"` for screen readers.

### Cross-component sync via CompanyContext

When used with `CompanyContext`, selecting a company triggers the following chain:

1. `onCompanyChange` fires with the selected `Company`
2. `CompanyContext.setSelectedCompany()` stores it in React state and `localStorage` (key: `selected_company`)
3. A `companySwitched` custom event is dispatched on `window`
4. Other components listening for `companySwitched` (e.g., UserDetails, OrderList) react to the change and refetch data for the new company
5. On logout, `CompanyContext` automatically clears the selected company

## SDK Services

This component does **not** call any SDK services directly. It is a purely presentational component that reads company data from the `user` prop (a `Contact` object already fetched via the Propeller SDK).

The company data it consumes is typically fetched as part of the user/viewer query:

```ts


const userService = new UserService(graphqlClient);
const viewer = await userService.getViewer({});
// viewer.companies.items contains the Company[] list
// viewer.company contains the default Company
```

### Related SDK types

```ts


// Contact — B2B user type
interface Contact {
  contactId: number;
  company: Company;           // Default company
  companies: {
    items: Company[];         // All assigned companies
  };
  // ...other fields
}

// Company
interface Company {
  companyId: number;
  name: string;
  // ...other fields
}
```

## GraphQL Queries and Mutations

The company data consumed by this component comes from the `viewer` query, which returns the authenticated user's profile including their company associations:

```graphql
query Viewer {
  viewer {
    ... on Contact {
      contactId
      firstName
      lastName
      company {
        companyId
        name
      }
      companies {
        items {
          companyId
          name
        }
      }
    }
  }
}
```

## CSS Classes

The component uses BEM-style class names for targeted styling:

| Class | Element |
|---|---|
| `.company-switcher` | Root container |
| `.company-switcher__trigger` | Trigger button |
| `.company-switcher__icon` | Icon span (also receives `icon-{value}`) |
| `.company-switcher__label` | Active company name (truncated at 160px) |
| `.company-switcher__chevron` | Chevron arrow (rotates on open) |
| `.company-switcher__dropdown` | Dropdown list container |
| `.company-switcher__option` | Individual company list item |
| `.company-switcher__option-name` | Company name text within option |
| `.company-switcher__option-check` | Checkmark SVG on active option |

---

## ForgotPassword

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/forgot-password

# ForgotPassword

A self-contained password reset request component. It renders an email form, calls the Propeller API to trigger a password reset email, and displays a confirmation message on success. The component manages its own loading, error, and success states internally.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic

```tsx



export default function ForgotPasswordPage() {
  return (
    <div className="max-w-md mx-auto mt-12">
      <ForgotPassword graphqlClient={graphqlClient} />
    </div>
  );
}
```

### Custom labels and callbacks

```tsx



<ForgotPassword
  graphqlClient={graphqlClient}
  title="Reset your password"
  subtitle="Enter your email and we'll send you a reset link."
  buttonText="Send Reset Link"
  responseMessage="Check your inbox for a reset link."
  labels={{
    email: 'Email address',
    emailPlaceholder: 'you@company.com',
  }}
  beforeForgotPassword={() => console.log('Requesting reset...')}
  afterForgotPassword={(result) => {
    if (result) {
      analytics.track('password_reset_requested');
    }
  }}
/>
```

### Inside a modal or dialog

```tsx



<Dialog>
  <ForgotPassword
    graphqlClient={graphqlClient}
    title="Forgot password?"
    afterForgotPassword={(result) => {
      if (result) closeDialog();
    }}
  />
</Dialog>
```

### Localized (Dutch)

```tsx
<ForgotPassword
  graphqlClient={graphqlClient}
  title="Wachtwoord vergeten?"
  subtitle="Vul je e-mailadres in om een resetlink te ontvangen."
  buttonText="Verstuur"
  responseMessage="Als er een account bestaat met dit e-mailadres, ontvang je binnenkort een link om je wachtwoord te resetten."
  labels={{
    email: 'E-mailadres',
    emailPlaceholder: 'naam@voorbeeld.nl',
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need full control over the password reset flow, you can build your own using the same SDK service:

```ts


// pseudo-code: maintain state for email, loading, submitted, and error in your framework

async function handlePasswordReset(
  graphqlClient: GraphQLClient,
  email: string,
  redirectUrl?: string,
  language?: string,
) {
  const userService = new UserService(graphqlClient);
  await userService.sendPasswordResetEmail({
    email,
    redirectUrl,
    language,
  });
  // On success: transition to a "submitted" state showing a confirmation message
  // On failure: display an error message to the user
}
```

The state flow for this feature is:

1. **Form** -- Render an email input and a submit button. On submit, call `handlePasswordReset()`.
2. **Loading** -- Disable the input and button while the API call is in flight.
3. **Success** -- Replace the form with a confirmation message (e.g., "If an account exists with this email, you will receive a reset link shortly."). This state is final.
4. **Error** -- Show an error message. Keep the form interactive so the user can retry.

This custom approach allows you to pass `redirectUrl` and `language` to the SDK (the built-in component only sends `email`) and gives you full control over markup, styling, and behavior.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | Yes | -- | Propeller SDK GraphQL client instance used to execute the password reset mutation. |

### Display

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `title` | `string` | No | `"Forgot password?"` | Heading displayed above the form. Set to empty string to hide. |
| `subtitle` | `string` | No | `""` | Secondary text below the title. Hidden when empty. |
| `buttonText` | `string` | No | `"Reset"` | Label for the submit button. |
| `responseMessage` | `string` | No | `"If an account exists with this email, you will receive a password reset link shortly."` | Confirmation message shown after successful submission. |

### Labels

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `labels` | `Record<string, string>` | No | `{}` | Custom labels for form fields. |

### Callbacks

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `beforeForgotPassword` | `() => void` | No | -- | Fired before the API call starts. Use for analytics, loading indicators, or validation. |
| `afterForgotPassword` | `(result: boolean) => void` | No | -- | Fired after the API call completes. Receives `true` on success, `false` on error. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function handlePasswordReset(
  graphqlClient: GraphQLClient,
  email: string,
  redirectUrl?: string,
  language?: string,
): Promise<boolean>
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | **required** | SDK client instance |
| `email` | `string` | **required** | Email address for password reset |
| `redirectUrl` | `string` | `undefined` | URL the user is redirected to after resetting their password |
| `language` | `string` | `undefined` | Language code for the email template |

### Callbacks

| Callback | When it fires | What to implement |
|---|---|---|
| `beforeForgotPassword` | Before the API call starts | Analytics tracking, loading indicators, or validation |
| `afterForgotPassword` | After the API call completes | Handle success (show confirmation) or failure (show error). Receives `true` on success, `false` on error. |

### UI-only props

The following props are purely presentational and are not part of the SDK layer: `title`, `subtitle`, `buttonText`, `responseMessage`, `labels`. These are the developer's responsibility to implement.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

Available label keys:

| Key | Default | Description |
|---|---|---|
| `email` | `"Email"` | Label above the email input field. |
| `emailPlaceholder` | `"name@example.com"` | Placeholder text inside the email input. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  email: 'Email',
  emailPlaceholder: 'name@example.com',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

The component transitions through four visual states:

1. **Form** -- Initial state. Renders an email input and a submit button.
2. **Loading** -- The submit button is disabled and displays a spinner while the API call is in progress. The email input is also disabled to prevent edits.
3. **Success** -- After a successful submission, the form is replaced with a green checkmark icon and the `responseMessage` text. This state is final; the form does not revert.
4. **Error** -- On API failure, a red error banner appears above the submit button with a descriptive message. The form remains interactive so the user can correct the email and retry.

Key details:
- The component always shows the success message after a successful call, regardless of whether the email actually exists in the system. This is a security best practice to prevent email enumeration.
- Multiple rapid submissions are prevented: `handleSubmit` returns early if `loading` is already `true`.
- The `beforeForgotPassword` callback fires before the loading state is set. The `afterForgotPassword` callback fires after the API response is received, with the result.

## GraphQL Mutation

Internally, `UserService.sendPasswordResetEmail()` executes the following GraphQL mutation:

```graphql
mutation triggerPasswordSendResetEmailEvent($input: PasswordRecoveryLinkInput!) {
  triggerPasswordSendResetEmailEvent(input: $input)
}
```

The `PasswordRecoveryLinkInput` accepted by the API:

```graphql
input PasswordRecoveryLinkInput {
  email: String!
  redirectUrl: String
  language: String
}
```

## SDK Services

The component uses `UserService` from `propeller-sdk-v2` to trigger the password reset email.

### UserService.sendPasswordResetEmail()

```ts


const userService = new UserService(graphqlClient);
const result = await userService.sendPasswordResetEmail({
  email: 'user@example.com',
});
// result: boolean (true on success)
```

The method accepts a `PasswordResetInput` object:

```ts
interface PasswordResetInput {
  /** The email address of the user */
  email: string;
  /** URL the user is redirected to after resetting their password */
  redirectUrl?: string;
  /** Text for the clickable reset link in the email */
  linkText?: string;
  /** Custom email subject line */
  subject?: string;
  /** Language code for the email template */
  language?: string;
}
```

The component currently only passes `email`. The optional fields (`redirectUrl`, `language`, etc.) can be exposed as additional props if needed.

---

## LoginForm

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/login-form

# LoginForm

A modular authentication form component with two operating modes: self-contained (handles login internally via the SDK) and delegation (parent handles authentication). Supports standalone login pages, header dropdowns, checkout flows, and modals.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Self-contained mode (recommended)

The component handles the entire authentication flow internally -- SDK login call, token extraction, GraphQL client header update, viewer fetch, event dispatch, and loading/error states.

```tsx



<LoginForm
  graphqlClient={graphqlClient}
  onForgotPasswordClick={() => router.push('/forgot-password')}
  onRegisterClick={() => router.push('/register')}
  afterLogin={(user, accessToken, refreshToken) => {
    // Tokens and user data are already available
    router.push('/account');
  }}
/>
```

### Delegation mode

When `onLoginSubmit` is provided, the component does not call the SDK. The parent is responsible for authentication, loading state, and error messages.

```tsx
const [loginLoading, setLoginLoading] = useState(false);
const [loginError, setLoginError] = useState('');

<LoginForm
  loginLoading={loginLoading}
  loginError={loginError}
  onForgotPasswordClick={() => router.push('/forgot-password')}
  onRegisterClick={() => router.push('/register')}
  onLoginSubmit={async (email, password) => {
    setLoginLoading(true);
    setLoginError('');
    try {
      await login(email, password);
      router.push('/account');
    } catch (error) {
      setLoginError('Login failed. Please check your credentials.');
    } finally {
      setLoginLoading(false);
    }
  }}
/>
```

### Checkout flow

Show a guest checkout option and hide the registration link:

```tsx
<LoginForm
  graphqlClient={graphqlClient}
  title="Log in to continue"
  displayRegisterLink={false}
  displayGuestCheckoutLink={true}
  onForgotPasswordClick={() => router.push('/forgot-password')}
  onGuestCheckoutClick={() => router.push('/checkout/guest')}
  afterLogin={() => router.push('/checkout')}
/>
```

### Header dropdown (compact mode)

When used inside a header dropdown, set `accountHeaderLoginForm` to render a compact layout with inline forgot-password and register links instead of the full-width sections:

```tsx
<LoginForm
  graphqlClient={graphqlClient}
  title=""
  accountHeaderLoginForm={true}
  onForgotPasswordClick={() => router.push('/forgot-password')}
  onRegisterClick={() => router.push('/register')}
  afterLogin={() => router.push('/account')}
/>
```

### Minimal form (no title, no extra links)

```tsx
<LoginForm
  graphqlClient={graphqlClient}
  title=""
  displayForgotPasswordLink={false}
  displayRegisterLink={false}
  displayGuestCheckoutLink={false}
  afterLogin={() => router.push('/account')}
/>
```

### Custom labels

```tsx
<LoginForm
  graphqlClient={graphqlClient}
  buttonText="Sign In"
  labels={{
    email: 'E-mailadres',
    password: 'Wachtwoord',
    emailPlaceholder: 'naam@voorbeeld.nl',
    forgotPassword: 'Wachtwoord vergeten?',
    registerText: 'Nog geen account?',
    registerLink: 'Registreren',
    guestCheckoutLink: 'Ga verder als gast',
  }}
  onForgotPasswordClick={() => router.push('/forgot-password')}
  onRegisterClick={() => router.push('/register')}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need a custom login form with different UI but the same authentication flow, you can use the SDK services directly:

### Self-contained login flow

```ts

  GraphQLClient,
  LoginService,
  UserService,
  LoginInput,
} from 'propeller-sdk-v2';

// pseudo-code: maintain state for email, password, loading, and error in your framework

async function handleLogin(graphqlClient: GraphQLClient, email: string, password: string) {
  // Step 1: Authenticate with credentials
  const loginService = new LoginService(graphqlClient);
  const loginInput: LoginInput = { email, password };
  const loginResponse = await loginService.login(loginInput);

  const session = loginResponse.session;
  if (!session?.accessToken || !session?.refreshToken) {
    throw new Error('Missing authentication tokens');
  }

  // Step 2: Update GraphQL client with auth header
  const currentConfig = graphqlClient.getConfig();
  graphqlClient.updateConfig({
    headers: {
      ...currentConfig.headers,
      Authorization: `Bearer ${session.accessToken}`,
    },
  });

  // Step 3: Fetch authenticated user profile
  const userService = new UserService(graphqlClient);
  const user = await userService.getViewer({});

  // Step 4: Store tokens in localStorage for persistence
  localStorage.setItem('accessToken', session.accessToken);
  localStorage.setItem('refreshToken', session.refreshToken);

  // Step 5: Notify other components via custom event
  window.dispatchEvent(new CustomEvent('userLoggedIn'));

  return { user, session };
  // On success: clear the form fields and navigate or update your app state
  // On failure: display an error message like "Invalid credentials"
}
```

### Delegation mode

```ts
// When you want the parent to handle authentication:
// Collect email and password from your form, then call the parent's handler.

async function handleDelegatedLogin(
  email: string,
  password: string,
  onLoginSubmit: (email: string, password: string) => void
) {
  onLoginSubmit(email, password);
  // Parent controls loading state and error messages
}
```

### Checkout flow

```ts
// Same as self-contained login, but after successful login navigate to checkout:
const { user, session } = await handleLogin(graphqlClient, email, password);
// Navigate to /checkout
```

### Header dropdown (compact mode)

```ts
// Same login flow as self-contained mode.
// The only difference is the UI layout (compact inline links).
// Use the same handleLogin function above.
```

### Minimal form

```ts
// Same login flow as self-contained mode.
// Omit forgot-password, register, and guest checkout links from your UI.
```

Your UI should render an email input, a password input, an error message area, and a submit button. Disable inputs while `loading` is true. On form submission, call `handleLogin()` and handle the result.

### Key integration points

- **`userLoggedIn` event**: Dispatch `new CustomEvent('userLoggedIn')` on `window` after storing tokens. The app's `AuthContext` listens for this event to update global auth state.
- **Token refresh**: Use `LoginService.exchangeRefreshToken(refreshToken)` to obtain a new access token when the current one expires.
- **Logout**: Use `UserService.logout()` and dispatch `new CustomEvent('userLoggedOut')` to clear auth state.
- **User type detection**: The `viewer` query returns either a `Contact` (B2B user with company) or `Customer` (B2C user). Check `__typename` or look for the `company` property to distinguish them.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core props

| Prop | Type | Default | Description |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | -- | SDK client for self-contained login. Required when `onLoginSubmit` is not provided. |
| `onLoginSubmit` | `(email: string, password: string) => void` | -- | Delegation mode: fires on submit, parent handles auth. When provided, `graphqlClient` is ignored. |

### Display props

| Prop | Type | Default | Description |
|---|---|---|---|
| `title` | `string` | `"Log in"` | Form title. Set to `""` to hide. |
| `subtitle` | `string` | `""` | Subtitle shown below the title. |
| `buttonText` | `string` | `"Login"` | Label for the submit button. |
| `accountHeaderLoginForm` | `boolean` | `true` | When `true`, renders a compact layout suitable for header dropdowns (inline links instead of full-width sections). |
| `displayForgotPasswordLink` | `boolean` | `true` | Show/hide the forgot password link. |
| `displayRegisterLink` | `boolean` | `true` | Show/hide the registration link/button. |
| `displayGuestCheckoutLink` | `boolean` | `true` | Show/hide the guest checkout link. |
| `labels` | `Record<string, string>` | `{}` | Override default label text (see Labels section). |

### Callback props

| Prop | Type | Description |
|---|---|---|
| `onForgotPasswordClick` | `(event?: any) => void` | Fires when the forgot password link is clicked. |
| `onRegisterClick` | `(event?: any) => void` | Fires when the register button/link is clicked. |
| `onGuestCheckoutClick` | `(event?: any) => void` | Fires when the guest checkout link is clicked. |
| `beforeLogin` | `() => void` | Called before the login process starts (both modes). |
| `afterLogin` | `(user: Contact \| Customer, accessToken?: string, refreshToken?: string, expiresAt?: string) => void` | Called after successful login with user data and tokens (self-contained mode). |

### Delegation mode props

These props are only used when `onLoginSubmit` is provided. In self-contained mode, the component manages its own loading and error states.

| Prop | Type | Default | Description |
|---|---|---|---|
| `loginLoading` | `boolean` | `false` | Shows loading spinner on the submit button. |
| `loginError` | `string` | -- | Error message displayed in the form. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


const loginService = new LoginService(graphqlClient);
const userService = new UserService(graphqlClient);

// Authenticate
async function login(input: LoginInput): Promise<Login>

// Fetch user profile after login
async function getViewer(params: {}): Promise<Contact | Customer>

// Refresh token
async function exchangeRefreshToken(refreshToken: string): Promise<Login>

// Logout
async function logout(): Promise<void>
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | -- | Client instance passed to `LoginService` and `UserService` constructors |
| `email` | `string` | -- | `LoginInput.email` in `loginService.login()` |
| `password` | `string` | -- | `LoginInput.password` in `loginService.login()` |

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onLoginSubmit` | Form submitted (delegation mode) | Handle authentication externally, manage loading/error state |
| `beforeLogin` | Before login process starts (both modes) | Any pre-login logic (e.g., analytics, form validation) |
| `afterLogin` | After successful login (self-contained mode) | Navigate to account/checkout, update app state with user and tokens |
| `onForgotPasswordClick` | Forgot password link clicked | Navigate to forgot password page |
| `onRegisterClick` | Register link/button clicked | Navigate to registration page |
| `onGuestCheckoutClick` | Guest checkout link clicked | Navigate to guest checkout flow |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `title` -- form title text
- `subtitle` -- subtitle text below title
- `buttonText` -- submit button label
- `accountHeaderLoginForm` -- compact layout toggle for header dropdowns
- `displayForgotPasswordLink` -- show/hide forgot password link
- `displayRegisterLink` -- show/hide registration link
- `displayGuestCheckoutLink` -- show/hide guest checkout link
- `loginLoading` -- loading state for delegation mode
- `loginError` -- error message for delegation mode
- `labels` -- UI string overrides

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `email` | `"Email"` | Email field label |
| `password` | `"Password"` | Password field label |
| `emailPlaceholder` | `"name@example.com"` | Email input placeholder |
| `passwordPlaceholder` | `"••••••••"` | Password input placeholder |
| `forgotPassword` | `"Forgot password?"` | Forgot password link text |
| `registerText` | `"Don't have an account?"` | Text above the register button |
| `registerLink` | `"Create an Account"` | Register button text |
| `guestCheckoutLink` | `"Continue as Guest"` | Guest checkout link text |
| `noAccount` | `"Don't have an account?"` | Text before register link (compact/header mode only) |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  email: 'Email',
  password: 'Password',
  emailPlaceholder: 'name@example.com',
  passwordPlaceholder: '••••••••',
  forgotPassword: 'Forgot password?',
  registerText: "Don't have an account?",
  registerLink: 'Create an Account',
  guestCheckoutLink: 'Continue as Guest',
  noAccount: "Don't have an account?",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Self-contained authentication flow

When `graphqlClient` is provided and `onLoginSubmit` is absent, the component executes this sequence on form submit:

1. Calls `beforeLogin()` callback if provided.
2. Sets internal loading state to `true` and clears any previous error.
3. Creates `LoginService` and `UserService` instances from the provided `graphqlClient`.
4. Calls `loginService.login({ email, password })` which executes the `login` GraphQL mutation.
5. Extracts `accessToken` and `refreshToken` from the response session.
6. Updates the `graphqlClient` headers with `Authorization: Bearer {accessToken}` so subsequent requests are authenticated.
7. Calls `userService.getViewer({})` to fetch the authenticated user profile (Contact or Customer).
8. Dispatches a `userLoggedIn` custom event on `window` -- this is picked up by `AuthContext` to update global auth state.
9. Resets the email and password form fields.
10. Calls `afterLogin(user, accessToken, refreshToken, expirationTime)` callback if provided.

If any step fails, the component displays a generic error message: "The credentials you entered don't match our records. Please try again."

### Delegation flow

When `onLoginSubmit` is provided:

1. Calls `beforeLogin()` callback if provided.
2. Calls `onLoginSubmit(email, password)` -- the parent handles authentication.
3. Loading state is controlled via `loginLoading` prop.
4. Error messages are controlled via `loginError` prop.

### Compact header mode

When `accountHeaderLoginForm` is `true`:
- The forgot password link and register section below the form are hidden.
- Instead, compact inline links for forgot password and register appear below the submit button.
- The full-width register button and guest checkout link are not rendered.

### Form states

- **Idle**: Form fields enabled, submit button shows `buttonText`.
- **Loading**: Form fields disabled, submit button shows a spinner and "Logging in..." text.
- **Error**: Red error banner appears between the password field and the submit button.

---

## GraphQL Queries and Mutations

### `login` mutation

The SDK executes this mutation internally via `LoginService.login()`:

```graphql
mutation login($input: LoginInput!) {
  login(input: $input) {
    session {
      accessToken
      refreshToken
      expirationTime
      email
      uid
      displayName
    }
  }
}
```

**Variables:**

```json
{
  "input": {
    "email": "user@example.com",
    "password": "password123"
  }
}
```

**Response:**

```json
{
  "data": {
    "login": {
      "session": {
        "accessToken": "eyJhbGciOiJSUzI1NiIs...",
        "refreshToken": "AMf-vBxG3...",
        "expirationTime": "2026-03-25T14:30:00Z",
        "email": "user@example.com",
        "uid": "abc123",
        "displayName": "John Doe"
      }
    }
  }
}
```

### `viewer` query

The SDK executes this query internally via `UserService.getViewer()`:

```graphql
query viewer {
  viewer {
    __typename
    ... on Contact {
      contactId
      firstName
      lastName
      email
      phone
      mobile
      company {
        companyId
        name
        taxNumber
        cocNumber
      }
      addresses {
        id
        firstName
        lastName
        street
        number
        postalCode
        city
        country
        type
        isDefault
      }
    }
    ... on Customer {
      customerId
      firstName
      lastName
      email
      phone
      mobile
      addresses {
        id
        firstName
        lastName
        street
        number
        postalCode
        city
        country
        type
        isDefault
      }
    }
  }
}
```

---

## SDK Services

The component uses two services from `propeller-sdk-v2` in self-contained mode:

### LoginService

Handles user authentication via the `login` GraphQL mutation.

```tsx


const loginService = new LoginService(graphqlClient);

const loginInput: LoginInput = {
  email: 'user@example.com',
  password: 'password123',
};

const loginResponse = await loginService.login(loginInput);

// loginResponse is a Login object with:
// - loginResponse.session.accessToken  (string)
// - loginResponse.session.refreshToken (string)
// - loginResponse.session.expirationTime (string | undefined)
```

### UserService

Fetches the authenticated user's profile after login via the `viewer` GraphQL query.

```tsx


const userService = new UserService(graphqlClient);

// After setting the Authorization header on graphqlClient:
const user = await userService.getViewer({});

// user is either a Contact (B2B) or Customer (B2C) based on __typename
// Contact has: company, addresses, firstName, lastName, email, etc.
// Customer has: addresses, firstName, lastName, email, etc.
```

---

## RegisterForm

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/register-form

# RegisterForm

A configurable user registration component that manages the full account creation flow for either Contact (B2B company) or Customer (B2C consumer) users, including company creation, address management, and automatic login.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage (both user types, full form)

```tsx



const graphqlClient = createGraphQLClient({ /* config */ });

<RegisterForm
  graphqlClient={graphqlClient}
  afterRegistration={(user) => router.push('/account')}
/>
```

### B2B company-only registration

```tsx
<RegisterForm
  graphqlClient={graphqlClient}
  showUserType="Contact"
  requiredFields={['firstName', 'lastName', 'phone', 'companyName', 'vatNumber', 'cocNumber']}
  afterRegistration={(user) => router.push('/account')}
/>
```

### B2C consumer-only registration

```tsx
<RegisterForm
  graphqlClient={graphqlClient}
  showUserType="Customer"
  requiredFields={['firstName', 'lastName', 'phone']}
  afterRegistration={(user) => router.push('/account')}
/>
```

### Full page integration with custom labels

```tsx
<RegisterForm
  graphqlClient={graphqlClient}
  title=""
  requiredFields={['firstName', 'lastName']}
  onLoginClick={() => router.push('/login')}
  afterRegistration={() => router.push('/account')}
  labels={{
    personalDetailsTitle: 'Personal Information',
    billingAddressTitle: 'Invoice Address',
    contactLabel: 'Business',
    customerLabel: 'Personal',
  }}
/>
```

### Registration without automatic login

```tsx
<RegisterForm
  graphqlClient={graphqlClient}
  automaticLogin={false}
  beforeRegistration={() => console.log('Starting registration...')}
  afterRegistration={(user) => {
    // user is registered but NOT logged in
    router.push('/login?registered=true');
  }}
/>
```

### With country dropdown

```tsx


<RegisterForm
  graphqlClient={graphqlClient}
  countries={countries}
  preferredLanguage="EN"
  afterRegistration={(user) => router.push('/account')}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need full control over the registration flow, you can build your own form using the same SDK services. Below is the complete Contact (B2B) registration flow.

### Required form fields

Your form needs to collect: `email`, `password`, `confirmPassword`, `firstName`, `lastName`, `companyName`, `vatNumber`, `cocNumber`, `phone`, `gender`, `street`, `number`, `numberExtension`, `postalCode`, `city`, `country`. Also track `loading`, `error`, and `userType` (Contact or Customer) state.

### Registration flow (B2B Contact)

```ts

  GraphQLClient,
  UserService,
  CompanyService,
  AddressService,
  Enums,
} from 'propeller-sdk-v2';

// pseudo-code: maintain form field state and loading/error state in your framework

async function registerContact(graphqlClient: GraphQLClient, formData: {
  email: string; password: string; firstName: string; lastName: string;
  companyName: string; vatNumber: string; phone: string;
  street: string; number: string; postalCode: string; city: string; country: string;
}) {
  const userService = new UserService(graphqlClient);
  const companyService = new CompanyService(graphqlClient);
  const addressService = new AddressService(graphqlClient);

  // Step 1: Create the company
  const company = await companyService.createCompany({
    name: formData.companyName,
    taxNumber: formData.vatNumber,
    email: formData.email,
  });

  // Step 2: Register the contact under the company
  const response = await userService.registerContact({
    contactRegisterInput: {
      email: formData.email,
      password: formData.password,
      firstName: formData.firstName,
      lastName: formData.lastName,
      primaryLanguage: 'NL',
      parentId: company.companyId,
    },
    companyAttributesInput: {},
    contactAttributesInput: {},
    contactPAConfigInput: { page: 1, offset: 10 },
  });

  // Step 3: Authenticate for subsequent address creation calls
  const session = response.session;
  if (session?.accessToken) {
    const currentConfig = graphqlClient.getConfig();
    graphqlClient.updateConfig({
      headers: {
        ...currentConfig.headers,
        Authorization: `Bearer ${session.accessToken}`,
      },
    });
  }

  // Step 4: Create invoice address
  await addressService.createCompanyAddress({
    firstName: formData.firstName,
    lastName: formData.lastName,
    company: formData.companyName,
    street: formData.street,
    number: formData.number,
    postalCode: formData.postalCode,
    city: formData.city,
    country: formData.country,
    type: Enums.AddressType.invoice,
    isDefault: Enums.YesNo.Y,
    companyId: company.companyId,
  });

  // Step 5: Create delivery address (copy of invoice)
  await addressService.createCompanyAddress({
    firstName: formData.firstName,
    lastName: formData.lastName,
    company: formData.companyName,
    street: formData.street,
    number: formData.number,
    postalCode: formData.postalCode,
    city: formData.city,
    country: formData.country,
    type: Enums.AddressType.delivery,
    isDefault: Enums.YesNo.Y,
    companyId: company.companyId,
  });

  // Step 6: Trigger login event for other components
  if (session?.accessToken && session?.refreshToken) {
    window.dispatchEvent(new CustomEvent('userLoggedIn'));
  }

  return { user: response.contact, session };
  // On success: navigate to the account page or show a success message
  // On failure: display the error message to the user
}
```

### Registration flow (B2C Customer)

For a B2C (Customer) registration, replace `registerContact` with `registerCustomer`, skip the `CompanyService.createCompany()` step, and use `AddressService.createCustomerAddress()` instead of `createCompanyAddress()`.

```ts

  GraphQLClient,
  UserService,
  AddressService,
  Enums,
} from 'propeller-sdk-v2';

async function registerCustomer(graphqlClient: GraphQLClient, formData: {
  email: string; password: string; firstName: string; lastName: string;
  phone: string; gender: string;
  street: string; number: string; postalCode: string; city: string; country: string;
}) {
  const userService = new UserService(graphqlClient);
  const addressService = new AddressService(graphqlClient);

  // Step 1: Register the customer
  const response = await userService.registerCustomer({
    customerRegisterInput: {
      email: formData.email,
      password: formData.password,
      firstName: formData.firstName,
      lastName: formData.lastName,
      gender: Enums.Gender.U,
      primaryLanguage: 'NL',
    },
    customerAttributesInput: {},
  });

  // Step 2: Authenticate for subsequent address creation calls
  const session = response.session;
  if (session?.accessToken) {
    const currentConfig = graphqlClient.getConfig();
    graphqlClient.updateConfig({
      headers: {
        ...currentConfig.headers,
        Authorization: `Bearer ${session.accessToken}`,
      },
    });
  }

  // Step 3: Create invoice address
  await addressService.createCustomerAddress({
    firstName: formData.firstName,
    lastName: formData.lastName,
    street: formData.street,
    number: formData.number,
    postalCode: formData.postalCode,
    city: formData.city,
    country: formData.country,
    type: Enums.AddressType.invoice,
    isDefault: Enums.YesNo.Y,
    customerId: response.customer.customerId,
  });

  // Step 4: Create delivery address (copy of invoice)
  await addressService.createCustomerAddress({
    firstName: formData.firstName,
    lastName: formData.lastName,
    street: formData.street,
    number: formData.number,
    postalCode: formData.postalCode,
    city: formData.city,
    country: formData.country,
    type: Enums.AddressType.delivery,
    isDefault: Enums.YesNo.Y,
    customerId: response.customer.customerId,
  });

  // Step 5: Trigger login event
  if (session?.accessToken && session?.refreshToken) {
    window.dispatchEvent(new CustomEvent('userLoggedIn'));
  }

  return { user: response.customer, session };
}
```

### Post-registration flow

1. Validate client-side that passwords match before making any API calls.
2. Call the registration function above.
3. If `automaticLogin` is desired and session tokens are present, dispatch `userLoggedIn` on `window` (picked up by AuthContext).
4. Call your success callback with the created user and session tokens.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | Yes | - | Configured GraphQL client for SDK service calls |
| `title` | `string` | No | `"Create account"` | Form title. Pass empty string to hide |
| `subtitle` | `string` | No | `""` | Subtitle displayed below the title |
| `buttonText` | `string` | No | `"Register"` | Label for the submit button |

### User Type Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `showUserType` | `'Contact' \| 'Customer' \| null` | No | `null` | `null` shows a type selector toggle. `'Contact'` forces B2B mode (shows company fields). `'Customer'` forces B2C mode |

### Configuration Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `requiredFields` | `string[]` | No | `[]` | Field names to mark as required (see Available Required Fields below) |
| `automaticLogin` | `boolean` | No | `true` | Automatically log the user in after successful registration |
| `labels` | `Record<string, string>` | No | `{}` | Override default labels for form fields and sections (see Available Labels below) |
| `preferredLanguage` | `string` | No | `'NL'` | Language code sent with the registration request |
| `countries` | `Record<string, string>` | No | `{}` | Key-value pairs of country codes and names for the country dropdown |

### Callback Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `beforeRegistration` | `() => void` | No | - | Called before the registration process starts |
| `afterRegistration` | `(user, accessToken?, refreshToken?, expiresAt?) => void` | No | - | Called after successful registration. Receives the created `Contact` or `Customer` object, plus session tokens when `automaticLogin` is enabled |
| `onLoginClick` | `() => void` | No | - | Callback when the "Log in" link is clicked |
| `displayLoginLink` | `boolean` | No | `true` | Show or hide the login link at the bottom of the form |

### Available Required Fields

`firstName`, `middleName`, `lastName`, `email` (always required), `password` (always required), `phone`, `mobile`, `gender`, `companyName`, `vatNumber`, `cocNumber`, `street`, `number`, `numberExtension`, `postalCode`, `city`, `country`

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function registerUser(
  graphqlClient: GraphQLClient,
  formData: {
    email: string;
    password: string;
    firstName: string;
    lastName: string;
    companyName?: string;
    vatNumber?: string;
    cocNumber?: string;
    phone?: string;
    gender?: Enums.Gender;
    street: string;
    number: string;
    numberExtension?: string;
    postalCode: string;
    city: string;
    country: string;
    preferredLanguage?: string;
  },
  userType: 'Contact' | 'Customer'
): Promise<{ user: Contact | Customer; session: { accessToken: string; refreshToken: string; expirationTime: string } }>
```

Types from `propeller-sdk-v2`: `GraphQLClient`, `Contact`, `Customer`, `Enums`, `ContactRegisterInput`, `CustomerRegisterInput`, `CreateCompanyInput`, `CustomerAddressCreateInput`, `CompanyAddressCreateInput`.

### Options table

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `graphqlClient` | `GraphQLClient` | *required* | `graphqlClient` prop — SDK client for all service calls |
| `email` | `string` | *required* | Form field — user email |
| `password` | `string` | *required* | Form field — user password |
| `firstName` | `string` | *required* | Form field — first name |
| `lastName` | `string` | *required* | Form field — last name |
| `companyName` | `string` | `undefined` | Form field — company name (Contact only) |
| `vatNumber` | `string` | `undefined` | Form field — VAT / tax number (Contact only) |
| `cocNumber` | `string` | `undefined` | Form field — Chamber of Commerce number (Contact only) |
| `phone` | `string` | `undefined` | Form field — phone number |
| `gender` | `Enums.Gender` | `Enums.Gender.U` | Form field — gender mapped from title radio buttons |
| `street` | `string` | *required* | Form field — street name |
| `number` | `string` | *required* | Form field — house number |
| `numberExtension` | `string` | `undefined` | Form field — apt/suite/unit |
| `postalCode` | `string` | *required* | Form field — postal code |
| `city` | `string` | *required* | Form field — city |
| `country` | `string` | *required* | Form field — country code |
| `preferredLanguage` | `string` | `'NL'` | `preferredLanguage` prop — language code sent with registration |
| `automaticLogin` | `boolean` | `true` | `automaticLogin` prop — whether to dispatch `userLoggedIn` event after registration |

### Callbacks table

| Callback | When it fires | What to implement |
|----------|--------------|-------------------|
| `beforeRegistration` | Before any API calls are made | Show loading state, disable form inputs |
| `afterRegistration` | After successful registration (and optional auto-login) | Navigate to account page or show success message. Receives `(user, accessToken?, refreshToken?, expiresAt?)` |
| `onLoginClick` | When the "Log in" link is clicked | Navigate to login page |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `title` — form title text
- `subtitle` — subtitle below the title
- `buttonText` — submit button label
- `labels` — override default labels for form fields and sections
- `requiredFields` — field names to mark as required in the UI
- `displayLoginLink` — show/hide login link
- `countries` — country dropdown options

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|-----|---------|-------------|
| `personalDetailsTitle` | `"Your details"` | Section title |
| `billingAddressTitle` | `"Billing address"` | Section title |
| `deliveryAddressTitle` | `"Delivery address"` | Section title |
| `passwordTitle` | `"Password"` | Section title |
| `sameAsDelivery` | `"Delivery address is the same as billing address"` | Checkbox label |
| `firstName` | `"First name"` | Field label |
| `middleName` | `"Insertion"` | Field label |
| `lastName` | `"Last name"` | Field label |
| `email` | `"Email address"` | Field label |
| `password` | `"Password"` | Field label |
| `confirmPassword` | `"Repeat password"` | Field label |
| `phone` | `"Phone number"` | Field label |
| `gender` | `"Title"` | Field label |
| `companyName` | `"Company name"` | Contact only |
| `vatNumber` | `"VAT number"` | Contact only |
| `cocNumber` | `"CoC number"` | Contact only |
| `street` | `"Street"` | Address field |
| `number` | `"Number"` | Address field |
| `numberExtension` | `"Apt/Suite/Unit"` | Address field |
| `postalCode` | `"Postal code"` | Address field |
| `city` | `"City"` | Address field |
| `country` | `"Country"` | Address field |
| `userTypeLabel` | `"Account type"` | Type selector label |
| `contactLabel` | `"Company"` | Contact toggle label |
| `customerLabel` | `"Consumer"` | Customer toggle label |
| `emailPlaceholder` | `"name@example.com"` | Placeholder |
| `passwordPlaceholder` | `"••••••••"` | Placeholder |
| `passwordMismatch` | `"Passwords do not match"` | Validation error message |
| `loginText` | `"Already have an account?"` | Login link prefix |
| `loginLink` | `"Log in"` | Login link text |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  personalDetailsTitle: 'Your details',
  billingAddressTitle: 'Billing address',
  deliveryAddressTitle: 'Delivery address',
  passwordTitle: 'Password',
  sameAsDelivery: 'Delivery address is the same as billing address',
  firstName: 'First name',
  middleName: 'Insertion',
  lastName: 'Last name',
  email: 'Email address',
  password: 'Password',
  confirmPassword: 'Repeat password',
  phone: 'Phone number',
  gender: 'Title',
  companyName: 'Company name',
  vatNumber: 'VAT number',
  cocNumber: 'CoC number',
  street: 'Street',
  number: 'Number',
  numberExtension: 'Apt/Suite/Unit',
  postalCode: 'Postal code',
  city: 'City',
  country: 'Country',
  userTypeLabel: 'Account type',
  contactLabel: 'Company',
  customerLabel: 'Consumer',
  emailPlaceholder: 'name@example.com',
  passwordPlaceholder: '••••••••',
  passwordMismatch: 'Passwords do not match',
  loginText: 'Already have an account?',
  loginLink: 'Log in',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Form Sections

The form is divided into four sections:

1. **Your Details** -- Account type toggle (Contact/Customer), title/gender radio buttons (Mr./Mrs./Other mapped to `Enums.Gender`), email, company fields (Contact only: company name, VAT number, CoC number), first name, middle name, last name, phone number.

2. **Billing Address** -- Postal code, street, number, apt/suite/unit, city, country.

3. **Delivery Address** -- A "same as billing address" checkbox (default: checked). When unchecked, shows a separate delivery address form.

4. **Password** -- Password and confirm password fields.

### Registration Flow

1. **Validation** -- Checks that a user type is selected and passwords match.
2. **`beforeRegistration` callback** -- Called if provided.
3. **Company creation** (Contact only) -- If company name is filled, creates a company via `CompanyService.createCompany()`.
4. **User registration** -- Calls `UserService.registerContact()` or `UserService.registerCustomer()` depending on user type.
5. **Authentication** -- Updates the GraphQL client with the returned `accessToken` to authorize subsequent address creation calls.
6. **Invoice address creation** -- Creates a billing/invoice address via `AddressService.createCustomerAddress()` or `AddressService.createCompanyAddress()`.
7. **Delivery address creation** -- Creates a delivery address. If "same as billing" is checked, copies the invoice address with `type: 'delivery'`. Otherwise uses the separate delivery form values.
8. **Auto-login** -- If `automaticLogin` is enabled and session tokens are present, dispatches a `userLoggedIn` custom event (picked up by AuthContext).
9. **`afterRegistration` callback** -- Called with the created user object and optional session tokens.

### Error Handling

- Password mismatch is caught client-side before any API calls.
- API errors are caught and displayed as an error message above the form.
- The form shows a loading state (disabled inputs) during submission.
- After successful registration, the form is replaced with a success state (`submitted = true`).

### User Type Behavior

- When `showUserType` is `null` (default), the form displays toggle buttons for the user to choose between "Company" and "Customer".
- When `showUserType` is `'Contact'`, company fields (company name, VAT number, CoC number) are always visible and the type selector is hidden.
- When `showUserType` is `'Customer'`, company fields are hidden and the type selector is hidden.

### Gender / Title Mapping

The title radio buttons map to Propeller SDK `Enums.Gender` values:
- Mr. = `Enums.Gender.M`
- Mrs. = `Enums.Gender.F`
- Other = `Enums.Gender.U` (default)

---

## SDK Services

The component uses three services from `propeller-sdk-v2` internally:

### UserService

Handles user registration for both Contact and Customer types.

```ts


const userService = new UserService(graphqlClient);

// Register a Contact (B2B user linked to a company)
const contactInput: ContactRegisterInput = {
  contactRegisterInput: {
    email: 'john@company.com',
    password: 'securePassword',
    firstName: 'John',
    lastName: 'Doe',
    phone: '+31612345678',
    gender: Enums.Gender.M,
    primaryLanguage: 'NL',
    parentId: 12345, // companyId from CompanyService.createCompany()
  },
  companyAttributesInput: {},
  contactAttributesInput: {},
  contactPAConfigInput: { page: 1, offset: 10 },
};
const contactResponse = await userService.registerContact(contactInput);
// contactResponse.contact — the created Contact
// contactResponse.session — { accessToken, refreshToken, expirationTime }

// Register a Customer (B2C user)
const customerInput: CustomerRegisterInput = {
  customerRegisterInput: {
    email: 'jane@example.com',
    password: 'securePassword',
    firstName: 'Jane',
    lastName: 'Doe',
    gender: Enums.Gender.F,
    primaryLanguage: 'EN',
  },
  customerAttributesInput: {},
};
const customerResponse = await userService.registerCustomer(customerInput);
// customerResponse.customer — the created Customer
// customerResponse.session — { accessToken, refreshToken, expirationTime }
```

### CompanyService

Creates a company record for Contact registrations.

```ts


const companyService = new CompanyService(graphqlClient);

const companyInput: CreateCompanyInput = {
  name: 'Acme Corp',
  taxNumber: 'NL123456789B01',  // VAT number
  cocNumber: '12345678',         // Chamber of Commerce number
  email: 'john@company.com',
  phone: '+31612345678',
};
const company = await companyService.createCompany(companyInput);
// company.companyId — used as parentId for registerContact()
```

### AddressService

Creates invoice and delivery addresses after registration.

```ts

  AddressService,
  CustomerAddressCreateInput,
  CompanyAddressCreateInput,
  Enums,
} from 'propeller-sdk-v2';

const addressService = new AddressService(graphqlClient);

// Create a customer address (B2C)
const customerAddress: CustomerAddressCreateInput = {
  firstName: 'Jane',
  lastName: 'Doe',
  street: 'Keizersgracht',
  number: '100',
  postalCode: '1015AA',
  city: 'Amsterdam',
  country: 'NL',
  type: Enums.AddressType.invoice,
  isDefault: Enums.YesNo.Y,
  customerId: 123,
};
await addressService.createCustomerAddress(customerAddress);

// Create a company address (B2B)
const companyAddress: CompanyAddressCreateInput = {
  firstName: 'John',
  lastName: 'Doe',
  company: 'Acme Corp',
  street: 'Herengracht',
  number: '200',
  postalCode: '1016BS',
  city: 'Amsterdam',
  country: 'NL',
  type: Enums.AddressType.delivery,
  isDefault: Enums.YesNo.Y,
  companyId: 456,
};
await addressService.createCompanyAddress(companyAddress);
```

---

## GraphQL Queries and Mutations

### registerContact mutation

```graphql
mutation registerContact($input: ContactRegisterInput!) {
  registerContact(input: $input) {
    contact {
      contactId
      firstName
      lastName
      email
    }
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

### registerCustomer mutation

```graphql
mutation registerCustomer($input: CustomerRegisterInput!) {
  registerCustomer(input: $input) {
    customer {
      customerId
      firstName
      lastName
      email
    }
    session {
      accessToken
      refreshToken
      expirationTime
    }
  }
}
```

### createCompany mutation

```graphql
mutation createCompany($input: CreateCompanyInput!) {
  createCompany(input: $input) {
    companyId
    name
    taxNumber
    cocNumber
  }
}
```

### createCustomerAddress / createCompanyAddress mutations

```graphql
mutation createCustomerAddress($input: CustomerAddressCreateInput!) {
  createCustomerAddress(input: $input) {
    id
    street
    number
    city
    country
    type
  }
}

mutation createCompanyAddress($input: CompanyAddressCreateInput!) {
  createCompanyAddress(input: $input) {
    id
    street
    number
    city
    country
    type
  }
}
```

---

## UserDetails

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/authentication/user-details

# UserDetails

Displays key information about the currently logged-in user. Supports both **Contact** (B2B) and **Customer** (B2C) user types from the Propeller e-commerce platform, and can present personal details, company information, associated companies, and default addresses.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### B2B Contact user with company info and addresses

```tsx





const COUNTRIES = [
  { code: 'NL', name: 'Netherlands' },
  { code: 'BE', name: 'Belgium' },
  { code: 'DE', name: 'Germany' },
];

export default function AccountPage() {
  const { state } = useAuth();
  const { selectedCompany } = useCompany();
  const user = state.user;

  if (!state.isAuthenticated || !user) return null;

  return (
    <UserDetails
      user={user as Contact | Customer}
      activeCompany={selectedCompany}
      showCompanyInfo={true}
      listAllContactCompanies={false}
      showDefaultInvoiceAddress={true}
      showDefaultDeliveryAddress={true}
      countries={COUNTRIES}
    />
  );
}
```

### B2B Contact with all companies listed

Show the full list of associated companies with an "Active" badge on the selected one:

```tsx
<UserDetails
  user={contactUser}
  activeCompany={selectedCompany}
  showCompanyInfo={true}
  listAllContactCompanies={true}
  showDefaultInvoiceAddress={true}
  showDefaultDeliveryAddress={true}
  countries={COUNTRIES}
/>
```

### B2C Customer (minimal)

For B2C customers, company-related sections are automatically hidden. Only personal info and addresses are shown:

```tsx
<UserDetails
  user={customerUser}
  activeCompany={null}
  showDefaultInvoiceAddress={true}
  showDefaultDeliveryAddress={false}
/>
```

### Read-only personal info only

Hide all address and company sections:

```tsx
<UserDetails
  user={user as Contact | Customer}
  activeCompany={null}
  showCompanyInfo={false}
  showDefaultInvoiceAddress={false}
  showDefaultDeliveryAddress={false}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need a custom user details display, here are the data access patterns you need.

### Accessing user data

```ts


// The user object comes from UserService.getViewer({}) or your auth state
// pseudo-code: obtain `user` (Contact | Customer) and `activeCompany` (Company | null) from your app state

// Determine user type
const isContact = user !== null && 'company' in user;

// Build display name
const name = [user.firstName, user.lastName].filter(Boolean).join(' ') || 'User';
// Email: user.email
```

### Resolving addresses

```ts
// Contact addresses come from the active company; Customer addresses are on the user directly
const addresses: Address[] = isContact
  ? (activeCompany?.addresses || [])
  : ((user as Customer).addresses || []);

// Find default addresses by type and isDefault flag
const defaultInvoiceAddress = addresses.find(
  (addr) => addr.type === 'invoice' && addr.isDefault === 'Y'
) ?? null;

const defaultDeliveryAddress = addresses.find(
  (addr) => addr.type === 'delivery' && addr.isDefault === 'Y'
) ?? null;
```

### Resolving company data (B2B Contact only)

```ts
// Active company fields: activeCompany.name, activeCompany.taxNumber, activeCompany.cocNumber

// All associated companies:
const contact = user as Contact;
const companies = contact.companies?.items?.length > 0
  ? contact.companies.items
  : contact.company
    ? [contact.company]
    : [];
// Mark the active company by comparing company.companyId === activeCompany?.companyId
```

### Field mapping summary

| Display section | Data source |
|---|---|
| Personal info (name, email) | `user.firstName`, `user.lastName`, `user.email` |
| Company info | `activeCompany.name`, `activeCompany.taxNumber`, `activeCompany.cocNumber` |
| Companies list | `contact.companies.items[]` |
| Invoice address | `addresses.find(a => a.type === 'invoice' && a.isDefault === 'Y')` |
| Delivery address | `addresses.find(a => a.type === 'delivery' && a.isDefault === 'Y')` |

Key points for a custom implementation:

- **User type check**: Use `'company' in user` to distinguish Contact from Customer.
- **Address source**: Contact addresses come from the active company; Customer addresses are on the user directly.
- **Default address filter**: Match on `type === 'invoice'|'delivery'` and `isDefault === 'Y'`.
- **Company switching**: Read the active company from `localStorage` (key: `selected_company`) and listen for the `companySwitched` custom event on `window` to react to changes.
- **Hydration safety**: Wrap client-only content in a mounted guard to avoid server/client mismatches.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `user` | `Contact \| Customer` | The currently logged-in user object from the Propeller SDK |
| `activeCompany` | `Company \| null` | The currently selected company (from `CompanyContext` or `companySwitched` event). Pass `null` for B2C customers. |

### Display toggles

| Prop | Type | Default | Description |
|---|---|---|---|
| `showCompanyInfo` | `boolean` | `true` | Show company name, tax number, and CoC number for the active company (Contact users only) |
| `listAllContactCompanies` | `boolean` | `false` | Show a list of all associated companies with an active indicator (Contact users only) |
| `showDefaultInvoiceAddress` | `boolean` | `true` | Show the user's default invoice address |
| `showDefaultDeliveryAddress` | `boolean` | `false` | Show the user's default delivery address |

### Data

| Prop | Type | Default | Description |
|---|---|---|---|
| `countries` | `{ code: string; name: string }[]` | `[]` | Country code-to-name mapping for displaying full country names in addresses. If omitted, raw ISO codes are shown. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderUserDetails(options: {
  user: Contact | Customer;
  activeCompany: Company | null;
}): void
```

Types from `propeller-sdk-v2`: `Contact`, `Customer`, `Company`, `Address`.

### Options table

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `user` | `Contact \| Customer` | *required* | `user` prop — the logged-in user object |
| `activeCompany` | `Company \| null` | *required* | `activeCompany` prop — currently selected company |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showCompanyInfo` — toggle company information card visibility
- `listAllContactCompanies` — toggle all-companies list visibility
- `showDefaultInvoiceAddress` — toggle invoice address display
- `showDefaultDeliveryAddress` — toggle delivery address display
- `countries` — country code-to-name mapping for address display

</TabItem>
</Tabs>

---

## Behavior

### Sections rendered

The component renders up to four card sections, each in a rounded card with shadow:

1. **Personal Information** -- Always shown. Displays the user's name and email address.
2. **Company Information** -- Shown when `showCompanyInfo` is `true` and the user is a Contact with an active company. Displays company name, tax number (if available), and CoC number (if available).
3. **Companies List** -- Shown when `listAllContactCompanies` is `true` and the user is a Contact. Lists all associated companies with the active company highlighted and badged.
4. **Default Addresses** -- Shown when either `showDefaultInvoiceAddress` or `showDefaultDeliveryAddress` is `true`. Renders invoice and/or delivery address in a two-column grid.

### User type detection

The component determines whether the user is a Contact (B2B) or Customer (B2C) by checking for the presence of the `company` property on the user object:

```ts
const isContact = user !== null && 'company' in user;
```

Company-related sections (Company Information, Companies List) are only rendered for Contact users, regardless of prop values.

### Address resolution

- **Contact users**: Addresses are sourced from the active company's `addresses` array (`activeCompany.addresses`).
- **Customer users**: Addresses are sourced from the user's own `addresses` array (`user.addresses`).
- Default addresses are found by filtering for `type === 'invoice'` or `type === 'delivery'` combined with `isDefault === 'Y'`.
- If no matching default address exists, the component displays an italicized "No invoice/delivery address found" message.

### Company switching

When used with the `CompanyContext` and `CompanySwitcher` component, UserDetails reacts to company changes in real-time. The parent page passes the `activeCompany` prop from the `useCompany()` hook. When the user switches companies via the CompanySwitcher (typically in the header), the context updates `selectedCompany`, and UserDetails re-renders with the new company's information and addresses.

The company switching flow:

1. User selects a company in `CompanySwitcher`
2. `CompanyContext` updates state and dispatches a `companySwitched` custom event
3. The parent page receives the updated `selectedCompany` from `useCompany()`
4. `UserDetails` re-renders with the new `activeCompany` prop, showing updated company info and addresses

### Hydration safety

The component uses a mounted guard (`isMounted` state set via `useEffect`) to prevent hydration mismatches. All content is rendered only after the component has mounted on the client, avoiding server/client divergence for data sourced from localStorage or context.

---

## SDK Services

This component is a **display-only** component. It does not call any SDK services internally -- it receives all data via props. The parent page is responsible for fetching the user and company data.

The data typically comes from:

### UserService

Used by the parent page or `AuthContext` to fetch the current user:

```ts


const userService = new UserService(graphqlClient);
const viewer = await userService.getViewer({});
// viewer is Contact | Customer
```

### CompanyContext

Used by the parent page to get the selected company:

```ts


const { selectedCompany } = useCompany();
// selectedCompany is Company | null
```

---

## GraphQL Queries

The component itself does not execute GraphQL queries, but the data it displays is fetched by the parent using these queries:

### Viewer query (fetches the logged-in user)

```graphql
query {
  viewer {
    ... on Contact {
      contactId
      firstName
      lastName
      email
      company {
        companyId
        name
        taxNumber
        cocNumber
        addresses {
          id
          firstName
          middleName
          lastName
          company
          street
          number
          numberExtension
          postalCode
          city
          country
          type
          isDefault
        }
      }
      companies {
        items {
          companyId
          name
          taxNumber
          cocNumber
          addresses {
            id
            firstName
            middleName
            lastName
            company
            street
            number
            numberExtension
            postalCode
            city
            country
            type
            isDefault
          }
        }
      }
    }
    ... on Customer {
      customerId
      firstName
      lastName
      email
      addresses {
        id
        firstName
        middleName
        lastName
        company
        street
        number
        numberExtension
        postalCode
        city
        country
        type
        isDefault
      }
    }
  }
}
```

---

## ActionCode

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/action-code

# ActionCode

Manages promotional or discount codes applied to the shopping cart. Allows users to enter and apply an action code, displays the currently applied code, and provides an option to remove it. Supports two modes: self-contained (handles SDK calls internally) and delegation (defers logic to parent callbacks).

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Self-contained mode (recommended)

The component calls `CartService` internally to apply and remove action codes. Use `afterActionCodeApply` and `afterActionCodeRemove` to sync the updated cart back to your app state.

```tsx




function CartPage() {
  const graphqlClient = useGraphqlClient();
  const { cart, saveCart } = useCart();

  return (
    <ActionCode
      graphqlClient={graphqlClient}
      cart={cart}
      afterActionCodeApply={(updatedCart) => saveCart(updatedCart)}
      afterActionCodeRemove={(updatedCart) => saveCart(updatedCart)}
    />
  );
}
```

### With custom title and labels

```tsx
<ActionCode
  graphqlClient={graphqlClient}
  cart={cart}
  title="Discount code"
  labels={{
    placeholder: 'Enter your discount code',
    apply: 'Redeem',
    applying: 'Redeeming...',
    remove: 'Clear',
    errorApply: 'Invalid code. Please check and try again.',
    errorRemove: 'Could not remove code. Please try again.',
  }}
  afterActionCodeApply={(updatedCart) => saveCart(updatedCart)}
  afterActionCodeRemove={(updatedCart) => saveCart(updatedCart)}
/>
```

### Delegation mode

When you need full control over the apply/remove logic, pass `onActionCodeApply` and/or `onActionCodeRemove`. The component will skip internal SDK calls and invoke your callbacks instead.

```tsx
<ActionCode
  graphqlClient={graphqlClient}
  cart={cart}
  onActionCodeApply={(code, currentCart) => {
    // Custom validation or API call
    console.log(`Applying code "${code}" to cart ${currentCart.cartId}`);
  }}
  onActionCodeRemove={(code, currentCart) => {
    // Custom removal logic
    console.log(`Removing code "${code}" from cart ${currentCart.cartId}`);
  }}
/>
```

### Read-only applied code (removal hidden)

```tsx
<ActionCode
  graphqlClient={graphqlClient}
  cart={cart}
  showRemoveCode={false}
  afterActionCodeApply={(updatedCart) => saveCart(updatedCart)}
/>
```

### With language and configuration

```tsx


<ActionCode
  graphqlClient={graphqlClient}
  cart={cart}
  language="EN"
  configuration={config}
  afterActionCodeApply={(updatedCart) => saveCart(updatedCart)}
  afterActionCodeRemove={(updatedCart) => saveCart(updatedCart)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

Standalone implementation using `CartService` directly, without the ActionCode component:

### Self-contained mode

```ts


// Initialize the service
const graphqlClient = new GraphQLClient({
  endpoint: '/api/graphql',
  headers: { 'Content-Type': 'application/json' },
});
const cartService = new CartService(graphqlClient);

// Apply an action code
async function applyCode(cart: Cart, code: string, language: string = 'NL'): Promise<Cart> {
  const variables: CartActionCodeVariables = {
    id: cart.cartId,
    input: { actionCode: code.trim() },
    language,
  };

  const updatedCart = await cartService.addActionCodeToCart(variables);
  return updatedCart;
  // On success: clear the code input and pass updatedCart to your cart state
  // On failure: display an error message to the user
}

// Remove the applied action code
async function removeCode(cart: Cart, language: string = 'NL'): Promise<Cart> {
  const variables: CartActionCodeVariables = {
    id: cart.cartId,
    input: { actionCode: cart.actionCode },
    language,
  };

  const updatedCart = await cartService.removeActionCodeFromCart(variables);
  return updatedCart;
  // On success: pass updatedCart to your cart state
  // On failure: display an error message to the user
}

// Check whether a code is currently applied
const hasAppliedCode = !!cart?.actionCode;
```

### Delegation mode

```ts
// When handling apply/remove yourself, no SDK calls are needed internally.
// Implement your own validation or API calls:

function onApply(code: string, cart: Cart) {
  // Custom validation or API call
  console.log(`Applying code "${code}" to cart ${cart.cartId}`);
}

function onRemove(code: string, cart: Cart) {
  // Custom removal logic
  console.log(`Removing code "${code}" from cart ${cart.cartId}`);
}
```

### With language and configuration

```ts


const cartService = new CartService(graphqlClient);

async function applyCode(cart: Cart, code: string, language: string, config?: any): Promise<Cart> {
  const variables: CartActionCodeVariables = {
    id: cart.cartId,
    input: { actionCode: code.trim() },
    language,
    imageSearchFilters: config?.imageSearchFiltersGrid,
    imageVariantFilters: config?.imageVariantFiltersSmall,
  };

  return await cartService.addActionCodeToCart(variables);
}
```

Your UI should render:
- When no code is applied: a text input for the code and an "Apply" button. On submit, call `applyCode()`.
- When a code is applied: display `cart.actionCode` as a badge with a "Remove" button. On click, call `removeCode()`.
- Disable inputs and buttons while a request is in flight. Show error messages on failure.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| `graphqlClient` | `GraphQLClient` | GraphQL client instance for Propeller SDK calls |
| `cart` | `Cart` | The current shopping cart object |

### Display

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `title` | `string` | `'Action code'` | Block heading text |
| `labels` | `Record<string, string>` | `{}` | Override any UI label (see [Labels](#labels) section) |
| `showRemoveCode` | `boolean` | `true` | Whether to show the remove button when a code is applied |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onActionCodeApply` | `(code: string, cart: Cart) => void` | Delegation callback for apply. When provided, the component skips the internal SDK call. |
| `onActionCodeRemove` | `(code: string, cart: Cart) => void` | Delegation callback for remove. When provided, the component skips the internal SDK call. |
| `afterActionCodeApply` | `(cart: Cart) => void` | Called after a successful internal apply, with the updated cart |
| `afterActionCodeRemove` | `(cart: Cart) => void` | Called after a successful internal remove, with the updated cart |

### Configuration

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `configuration` | `any` | — | App configuration object (provides `imageSearchFiltersGrid` and `imageVariantFiltersSmall` for cart queries) |
| `language` | `string` | `'NL'` | Language code passed to CartService operations |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function Signature

```ts


const cartService = new CartService(graphqlClient);

async function addActionCodeToCart(variables: CartActionCodeVariables): Promise<Cart>;
async function removeActionCodeFromCart(variables: CartActionCodeVariables): Promise<Cart>;
```

### Options Table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `id` | `number` | — | `cart.cartId` |
| `input.actionCode` | `string` | — | The action code string to apply or remove |
| `language` | `string` | `'NL'` | Language code for cart operations |
| `imageSearchFilters` | `object` | — | `configuration.imageSearchFiltersGrid` |
| `imageVariantFilters` | `object` | — | `configuration.imageVariantFiltersSmall` |

### Callbacks Table

| Callback | When it fires | What to implement |
|---|---|---|
| `afterActionCodeApply` | After a successful internal apply | Save the updated cart to your app state. |
| `afterActionCodeRemove` | After a successful internal remove | Save the updated cart to your app state. |
| `onActionCodeApply` | User submits a code (delegation mode) | Handle apply logic yourself. SDK call is skipped. |
| `onActionCodeRemove` | User clicks remove (delegation mode) | Handle remove logic yourself. SDK call is skipped. |

### UI-Only Props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `title` — block heading text
- `labels` — customizable UI strings
- `showRemoveCode` — show/hide the remove button

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|-----|---------|-------------|
| `placeholder` | `'Enter action code'` | Input field placeholder text |
| `apply` | `'Apply'` | Apply button label |
| `applying` | `'Applying...'` | Apply button label during loading |
| `remove` | `'Remove'` | Remove button label |
| `errorApply` | `'Failed to apply action code. Please try again.'` | Error shown when apply fails |
| `errorRemove` | `'Failed to remove action code. Please try again.'` | Error shown when remove fails |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  placeholder: 'Enter action code',
  apply: 'Apply',
  applying: 'Applying...',
  remove: 'Remove',
  errorApply: 'Failed to apply action code. Please try again.',
  errorRemove: 'Failed to remove action code. Please try again.',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Apply flow

1. User enters a code in the text input and clicks "Apply" (or presses Enter).
2. If the input is empty or the component is already loading, the action is ignored.
3. **Delegation mode**: If `onActionCodeApply` is provided, it is called with the code and current cart. No SDK call is made.
4. **Self-contained mode**: A `CartService` instance is created and `addActionCodeToCart()` is called.
5. On success, the input is cleared and `afterActionCodeApply` is called with the updated cart.
6. On failure, an error message is displayed below the input.

### Remove flow

1. User clicks the "Remove" button next to the applied code.
2. If the component is loading or no code is applied, the action is ignored.
3. **Delegation mode**: If `onActionCodeRemove` is provided, it is called with the applied code and current cart. No SDK call is made.
4. **Self-contained mode**: `removeActionCodeFromCart()` is called via `CartService`.
5. On success, `afterActionCodeRemove` is called with the updated cart. The input form reappears.
6. On failure, an error message is displayed.

### State transitions

- **No code applied**: Shows text input + "Apply" button.
- **Code applied**: Shows a badge with the applied code and a "Remove" button (unless `showRemoveCode={false}`).
- **Loading**: Both the input and buttons are disabled. The apply button text changes to the `applying` label.
- **Error**: A red error message appears below the input/badge area. It is cleared on the next apply or remove attempt.

### Hydration

The component uses an `isMounted` guard to prevent hydration mismatches. The interactive content (input, buttons, applied code badge) only renders after the component has mounted on the client.

## GraphQL Mutations

Under the hood, `CartService` executes these GraphQL mutations:

### Apply action code

```graphql
mutation CartAddActionCode($id: Int!, $input: CartActionCodeInput!, $language: String) {
  cartAddActionCode(id: $id, input: $input) {
    cartId
    actionCode
    total {
      subTotal
      discount
      totalNet
      totalGross
    }
    # ... other cart fields
  }
}
```

### Remove action code

```graphql
mutation CartRemoveActionCode($id: Int!, $input: CartActionCodeInput!, $language: String) {
  cartRemoveActionCode(id: $id, input: $input) {
    cartId
    actionCode
    total {
      subTotal
      discount
      totalNet
      totalGross
    }
    # ... other cart fields
  }
}
```

Both mutations accept a `CartActionCodeInput` with a single field:

```graphql
input CartActionCodeInput {
  actionCode: String!
}
```

## SDK Services

The component uses **`CartService`** from `propeller-sdk-v2` with the following methods:

### `CartService.addActionCodeToCart(variables)`

Applies an action code to the cart. Accepts `CartActionCodeVariables`:

```ts


const cartService = new CartService(graphqlClient);
const variables: CartActionCodeVariables = {
  id: cart.cartId,
  input: {
    actionCode: 'SUMMER20',
  },
  language: 'NL',
  imageSearchFilters: config?.imageSearchFiltersGrid,
  imageVariantFilters: config?.imageVariantFiltersSmall,
};

const updatedCart = await cartService.addActionCodeToCart(variables);
```

### `CartService.removeActionCodeFromCart(variables)`

Removes an action code from the cart. Uses the same `CartActionCodeVariables` shape:

```ts
const variables: CartActionCodeVariables = {
  id: cart.cartId,
  input: {
    actionCode: cart.actionCode, // currently applied code
  },
  language: 'NL',
};

const updatedCart = await cartService.removeActionCodeFromCart(variables);
```

### Reading the applied code

The currently applied action code is available on `cart.actionCode`. The component checks this field to determine whether to show the input form or the applied-code badge.

---

## AddToCart

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/add-to-cart

# AddToCart

A self-contained component that renders a quantity selector and an **Add** button for adding products to a Propeller Commerce cart. It handles cart resolution (existing cart lookup or new cart creation), optional stock validation, and user feedback via a toast notification or a confirmation modal.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Simple product

```tsx




<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={product}
  cartId={cart?.cartId}
  configuration={config}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
/>
```

### With automatic cart creation

When no cart exists yet, `createCart` tells the component to find or create one automatically. Always pair it with `onCartCreated` so the new cart ID is persisted in your app state.

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={product}
  configuration={config}
  createCart={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart, addedItem) => {
    saveCart(updatedCart);
    console.log('Added item:', addedItem);
  }}
/>
```

### Cluster product with selected options

For configurable products (clusters), pass the `cluster` object and the selected child product IDs. The component converts `childItems` into `CartChildItemInput[]` internally.

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={selectedVariant}
  cartId={cart?.cartId}
  configuration={config}
  cluster={cluster}
  childItems={[optionProductId1, optionProductId2]}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Bundle with custom price

Override the calculated price when you manage pricing externally (e.g. bundle discounts).

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={bundleProduct}
  cartId={cart?.cartId}
  configuration={config}
  price={49.95}
  notes="Bundle: Summer starter pack"
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Quantity rules (minimumQuantity and unit)

The component reads `product.minimumQuantity` and `product.unit` to enforce step increments and a minimum starting quantity. For example, a product sold in packs of 6 with a minimum of 12:

```tsx
// product.minimumQuantity = 12, product.unit = 6
// Quantity input starts at 12 and increments/decrements by 6

<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={bulkProduct}  // { minimumQuantity: 12, unit: 6, ... }
  cartId={cart?.cartId}
  configuration={config}
  allowIncrDecr={true}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Modal confirmation instead of toast

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={product}
  cartId={cart?.cartId}
  configuration={config}
  showModal={true}
  onProceedToCheckout={() => router.push('/checkout')}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Custom add-to-cart handler

Bypass the internal `CartService` call entirely by providing `onAddToCart`. You must return a `Cart` object.

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={product}
  configuration={config}
  onAddToCart={(product, clusterId, quantity, childItems, notes, price) => {
    return myCustomAddToCart(product.productId, quantity);
  }}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Localized labels (Dutch)

```tsx
<AddToCart
  graphqlClient={graphqlClient}
  user={authState.user}
  product={product}
  cartId={cart?.cartId}
  configuration={config}
  language="NL"
  labels={{
    add: 'Toevoegen',
    adding: 'Toevoegen...',
    addedToCart: 'toegevoegd aan winkelwagen',
    outOfStock: 'Onvoldoende voorraad',
    errorAdding: 'Kan product niet toevoegen',
    noCartId: 'Geen winkelwagen beschikbaar',
    modalTitle: 'Toegevoegd aan winkelwagen',
    quantity: 'Aantal',
    continueShopping: 'Verder winkelen',
    proceedToCheckout: 'Naar afrekenen',
  }}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need full control over the add-to-cart flow without using this component, here is a standalone implementation using `CartService` directly:

```tsx


async function addProductToCart(
  graphqlClient: GraphQLClient,
  cartId: string,
  product: Product,
  quantity: number,
  options?: {
    clusterId?: number;
    childItems?: { productId: number; quantity: number }[];
    notes?: string;
    price?: number;
    language?: string;
  }
): Promise<Cart> {
  const cartService = new CartService(graphqlClient);

  const cart = await cartService.addItemToCart({
    id: cartId,
    input: {
      productId: product.productId,
      quantity,
      ...(options?.clusterId !== undefined && { clusterId: options.clusterId }),
      ...(options?.childItems && { childItems: options.childItems }),
      ...(options?.notes && { notes: options.notes }),
      ...(options?.price !== undefined && { price: options.price }),
    },
    language: options?.language || 'NL',
    // Include image filters so the returned cart has product images
    imageSearchFilters: { type: ['default'] },
    imageVariantFilters: {
      transformations: [{ name: 'w', value: '200' }, { name: 'h', value: '200' }],
    },
  });

  return cart;
}

// Usage:
const updatedCart = await addProductToCart(graphqlClient, 'cart-abc-123', product, 2);
```

To also create a cart from scratch:

```tsx


async function createCart(
  graphqlClient: GraphQLClient,
  userId: { contactId?: number; companyId?: number; customerId?: number }
): Promise<Cart> {
  const cartService = new CartService(graphqlClient);

  const input: CartStartInput = {
    language: 'NL',
    ...(userId.contactId && { contactId: userId.contactId }),
    ...(userId.companyId && { companyId: userId.companyId }),
    ...(userId.customerId && { customerId: userId.customerId }),
  };

  const vars: CartStartVariables = {
    input,
    language: 'NL',
    imageSearchFilters: { type: ['default'] },
    imageVariantFilters: {
      transformations: [{ name: 'w', value: '200' }, { name: 'h', value: '200' }],
    },
  };

  return await cartService.startCart(vars);
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `graphqlClient` | `GraphQLClient` | Initialized Propeller SDK GraphQL client |
| `user` | `Contact \| Customer \| null` | Authenticated user, used for cart creation and lookup |
| `product` | `Product` | The product to add. `product.productId` is sent to the cart mutation; `product.names[0].value` appears in the toast message |
| `configuration` | `any` | Config object providing `imageSearchFiltersGrid`, `imageVariantFiltersSmall`, and `urls.getProductUrl()` for cart API calls and modal links |

### Cart

| Prop | Type | Default | Description |
|---|---|---|---|
| `cartId` | `string` | -- | ID of an existing cart to add the item to. Required when `onAddToCart` is not provided and `createCart` is `false` |
| `createCart` | `boolean` | `false` | When `true` and no `cartId` is available, the component looks up or creates a cart via `CartService`. Always pair with `onCartCreated` |
| `onCartCreated` | `(cart: Cart) => void` | -- | Called after a new cart is created internally. Use this to persist the cart in your app state. Without it, a new cart is created on every click |
| `language` | `string` | `'NL'` | Language code forwarded to all CartService operations |

### Product / Item

| Prop | Type | Default | Description |
|---|---|---|---|
| `cluster` | `Cluster` | -- | Cluster object for configurable products. `cluster.clusterId` is sent in the cart mutation |
| `childItems` | `number[]` | -- | Product IDs of the selected cluster child options. Converted to `CartChildItemInput[]` internally |
| `notes` | `string` | -- | Free-text notes attached to the cart item |
| `price` | `number` | -- | Custom unit price override. Omit to use the calculated price |

### Behavior

| Prop | Type | Default | Description |
|---|---|---|---|
| `allowIncrDecr` | `boolean` | `true` | Renders `-` and `+` buttons beside the quantity input. Set to `false` for a plain number input |
| `enableStockValidation` | `boolean` | `false` | Checks `product.inventory.totalQuantity` before adding. Shows an error toast if quantity exceeds available stock |
| `showModal` | `boolean` | `false` | After a successful add, shows a confirmation modal instead of the toast |
| `beforeAddToCart` | `() => boolean` | -- | Called before adding. Return `false` to abort (e.g. failed form validation) |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onAddToCart` | `(product, clusterId?, quantity?, childItems?, notes?, price?, showModal?) => Cart` | Fully replaces the internal `CartService.addItemToCart` call. The returned `Cart` is passed to `afterAddToCart` |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | Called after every successful add. Receives the updated cart and the matching `CartMainItem` (found by `productId`) |
| `onProceedToCheckout` | `() => void` | Called when the user clicks "Proceed to checkout" in the modal |

### Appearance

| Prop | Type | Default | Description |
|---|---|---|---|
| `className` | `string` | -- | CSS class applied to the root `<div>` |
| `labels` | `Record<string, string>` | -- | Override any UI string. See Labels table below |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function addProductToCart(
  graphqlClient: GraphQLClient,
  cartId: string,
  product: Product,
  quantity: number,
  options?: {
    clusterId?: number;
    childItems?: { productId: number; quantity: number }[];
    notes?: string;
    price?: number;
    language?: string;
  }
): Promise<Cart>
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cartId` | `string` | *required* | `id` in `CartService.addItemToCart()` |
| `product.productId` | `number` | *required* | `input.productId` |
| `quantity` | `number` | *required* | `input.quantity` |
| `clusterId` | `number` | -- | `input.clusterId` |
| `childItems` | `{ productId: number; quantity: number }[]` | -- | `input.childItems` |
| `notes` | `string` | -- | `input.notes` |
| `price` | `number` | -- | `input.price` |
| `language` | `string` | `'NL'` | `language` param on all CartService operations |

### Cart resolution

When no cart ID is available:

1. Call `CartService.getCarts()` to find existing carts for the user (by `contactId`/`companyId` for B2B or `customerId` for B2C).
2. If found, adopt the most recent one.
3. If not found, call `CartService.startCart()` with a `CartStartInput` containing the user IDs and language.
4. After creating a new cart, assign default invoice and delivery addresses from the user's address book via `CartService.updateCartAddress`.

### Callbacks table

| Callback | Purpose |
|---|---|
| `onCartCreated` | Persist the new cart in your app state after automatic cart creation |
| `afterAddToCart` | Sync the updated cart to your app state after a successful add |
| `onProceedToCheckout` | Navigate to checkout from the confirmation modal |
| `beforeAddToCart` | Gate the add operation (return `false` to abort) |

### UI-only props (no SDK equivalent)

The following props control visual presentation only and have no SDK counterpart: `allowIncrDecr`, `showModal`, `className`, `labels`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Shown when |
|---|---|---|
| `add` | `'Add'` | Button idle state |
| `adding` | `'Adding...'` | Button loading state |
| `addedToCart` | `'added to cart'` | Success toast (appended to product name) |
| `outOfStock` | `'Insufficient stock available'` | Error toast when stock validation blocks the add |
| `noCartId` | `'No cart ID provided'` | Error toast when no cart is available |
| `errorAdding` | `'Failed to add item to cart'` | Error toast on API exception |
| `modalTitle` | `'Added to cart'` | Modal title bar heading |
| `quantity` | `'Quantity'` | Label in the modal product row |
| `continueShopping` | `'Continue shopping'` | Left modal button |
| `proceedToCheckout` | `'Proceed to checkout'` | Right modal button |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  add: 'Add',
  adding: 'Adding...',
  addedToCart: 'added to cart',
  outOfStock: 'Insufficient stock available',
  noCartId: 'No cart ID provided',
  errorAdding: 'Failed to add item to cart',
  modalTitle: 'Added to cart',
  quantity: 'Quantity',
  continueShopping: 'Continue shopping',
  proceedToCheckout: 'Proceed to checkout',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Quantity rules

The component reads two properties from the `product` object to control quantity behavior:

- **`product.minimumQuantity`** -- The lowest allowed quantity. The quantity input initializes to this value on mount. If not set or zero, defaults to `1`.
- **`product.unit`** -- The step increment for the `+`/`-` buttons. For example, a `unit` of `6` means quantity moves in steps of 6. If not set or zero, defaults to `1`.

When the user types a value manually, the component snaps it to the nearest valid step: `Math.round((value - min) / step) * step + min`.

### Cart ID resolution

When `onAddToCart` is not provided, the component resolves the cart ID in this order:

1. Uses `props.cartId` if present.
2. Falls back to an internally cached `activeCartId` (set by a previous `initCart` call in the same session).
3. If neither exists and `createCart` is `true`:
   - Calls `CartService.getCarts()` to find existing carts for the user (by `contactId`/`companyId` for B2B or `customerId` for B2C).
   - If found, adopts the most recent one and fires `onCartCreated`.
   - If not found, calls `CartService.startCart()`, assigns default invoice and delivery addresses from the user's address book, then fires `onCartCreated`.
4. If still no cart ID, shows the `noCartId` error toast.

### New cart address assignment

When a new cart is created, the component automatically finds the user's default invoice and delivery addresses (where `isDefault === 'Y'`) and assigns them via `CartService.updateCartAddress`. For B2B (Contact) users, addresses come from `user.company.addresses`; for B2C (Customer) users, from `user.addresses`.

### Toast notifications

- Position: fixed, top-right corner (`top-4 right-4`).
- Auto-dismisses after 3 seconds; can be closed immediately with the dismiss button.
- Green for success, red for errors.
- Suppressed on success when `showModal` is `true` (the modal takes over). Error toasts still appear.

### Modal confirmation (`showModal: true`)

- A backdrop overlay covers the page; clicking it closes the modal.
- The modal panel displays: product image, product name (linked to the product page), SKU, quantity, price, and any cluster child items with their names and prices.
- Two action buttons: "Continue shopping" (closes modal) and "Proceed to checkout" (closes modal and fires `onProceedToCheckout`).

### Stock validation (`enableStockValidation: true`)

- Reads `product.inventory.totalQuantity` before adding.
- Blocks the add and shows the `outOfStock` toast if the requested quantity exceeds available stock.
- No additional API call is made; it relies on the `inventory` field already present on the `Product` object.

## GraphQL Mutation

Under the hood, `CartService.addItemToCart` executes a mutation like the following:

```graphql
mutation CartAddItem(
  $id: String!
  $input: CartItemInput!
  $language: String
  $imageSearchFilters: MediaImageProductSearchInput
  $imageVariantFilters: TransformationsInput
) {
  cartAddItem(id: $id, input: $input) {
    cartId
    items {
      productId
      quantity
      totalSum
      totalSumNet
      product {
        productId
        sku
        names(language: $language) { value }
        media {
          images(search: $imageSearchFilters) {
            items {
              imageVariants(input: $imageVariantFilters) { url }
            }
          }
        }
      }
      childItems {
        productId
        quantity
        totalSum
        product {
          names(language: $language) { value }
        }
      }
    }
    total { subTotal totalNet totalGross }
  }
}
```

Variables for a simple product:

```json
{
  "id": "cart-abc-123",
  "input": {
    "productId": 42,
    "quantity": 2
  },
  "language": "NL"
}
```

Variables for a cluster product with child options:

```json
{
  "id": "cart-abc-123",
  "input": {
    "productId": 42,
    "quantity": 1,
    "clusterId": 100,
    "childItems": [
      { "productId": 201, "quantity": 1 },
      { "productId": 202, "quantity": 1 }
    ]
  },
  "language": "NL"
}
```

## SDK Services

The component uses the following services from `propeller-sdk-v2`:

| Service | Methods used | Purpose |
|---|---|---|
| `CartService` | `addItemToCart` | Adds the product (with optional cluster, child items, notes, price) to the cart |
| `CartService` | `getCarts` | Finds existing carts for the user when `createCart` is enabled |
| `CartService` | `startCart` | Creates a new cart when no existing cart is found |
| `CartService` | `getCart` | Fetches full cart data after finding an existing cart |
| `CartService` | `updateCartAddress` | Assigns default invoice and delivery addresses from the user's address book to a newly created cart |

All SDK types used: `GraphQLClient`, `Product`, `Cart`, `Cluster`, `Contact`, `Customer`, `CartService`, `CartChildItemInput`, `CartSearchInput`, `CartStartInput`, `CartStartVariables`, `CartMainItem`, `CartBaseItem`, `Address`, `Enums`.

---

## CartCarriers

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-carriers

# CartCarriers

Displays the available shipping carriers for a shopping cart, letting the user pick one. Each carrier card shows the carrier name, optional logo, price, and delivery deadline.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic

```tsx


<CartCarriers
  cart={cart}
  onCarrierSelect={(carrier) => console.log('Selected:', carrier.name)}
/>
```

### With custom price formatting and labels

```tsx
<CartCarriers
  cart={cart}
  onCarrierSelect={handleCarrierSelect}
  formatPrice={(price) => `$ ${price.toFixed(2)}`}
  labels={{
    noCarriers: 'No shipping options available for your order.',
    deliveryDeadline: 'Estimated delivery:',
  }}
/>
```

### Hide logos and prices (name-only cards)

```tsx
<CartCarriers
  cart={cart}
  showCarrierLogo={false}
  showPrice={false}
  onCarrierSelect={handleCarrierSelect}
/>
```

### Inside a checkout flow with carrier persistence

```tsx
const handleCarrierSelect = async (carrier: CartCarrier) => {
  // Update the cart with the selected carrier via CartService
  await cartService.setCarrier(cart.cartId, carrier.name);
  // Refresh local cart state
  const updatedCart = await cartService.getCart(cart.cartId);
  saveCart(updatedCart);
};

<CartCarriers
  cart={cart}
  onCarrierSelect={handleCarrierSelect}
  carriersContainerClass="checkout-carriers mt-4"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom carrier selector without this component, you need:

1. **Read `cart.carriers`** -- an array of `CartCarrier` objects, each with `name`, `price`, `logo` (optional URL), and `deliveryDeadline` (optional string).

2. **Track selection state** -- store the selected carrier name locally. There is no "selected" flag on `CartCarrier` itself.

3. **Persist the selection** -- call `CartService.setCarrier(cartId, carrierName)` (or the `cartSetCarrier` mutation directly) when the user picks a carrier. This updates `cart.postageData` so totals reflect the shipping cost.

4. **Format prices** -- `carrier.price` is a raw number. Format it with your locale-aware formatter or fall back to a simple `toFixed(2)`.

5. **Handle the empty state** -- when `cart.carriers` is empty or undefined, no shipping options are available (usually because no delivery address has been set yet, or the backend has no rules matching the cart).

### Basic

```ts



// Fetch the cart (which includes carriers)
const cartService = new CartService(graphqlClient);
const cart = await cartService.getCart(cartId);

const carriers = cart?.carriers || [];
// If `carriers` is empty, show an empty-state message.

// Track the selected carrier name in your framework's state mechanism.
let selectedCarrierName: string = '';

function selectCarrier(carrier: CartCarrier, cartId: string) {
  selectedCarrierName = carrier.name;

  // Persist the selection to the API
  cartService.setCarrier(cartId, carrier.name);
}

// Render a list of carriers. For each carrier, display `carrier.name` and
// `carrier.price.toFixed(2)`. Highlight the carrier whose name matches
// `selectedCarrierName`. On click, call `selectCarrier(carrier, cart.cartId)`.
```

### Inside a checkout flow with carrier persistence

```ts



const cartService = new CartService(graphqlClient);

async function handleCarrierSelect(carrier: CartCarrier, cartId: string): Promise<Cart> {
  // Persist the selection to the API
  await cartService.setCarrier(cartId, carrier.name);
  // Refresh local cart state
  const updatedCart = await cartService.getCart(cartId);
  return updatedCart;
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `cart` | `Cart` | Shopping cart object. The component reads `cart.carriers` to render the list. |

### Display

| Prop | Type | Default | Description |
|---|---|---|---|
| `showCarrierLogo` | `boolean` | `true` | Show the carrier logo image when the carrier has a `logo` URL. |
| `showPrice` | `boolean` | `true` | Show the carrier shipping price next to the name. |
| `carriersContainerClass` | `string` | `'cart-carriers'` | CSS class applied to the outermost wrapper `div`. |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onCarrierSelect` | `(carrier: CartCarrier) => void` | Fired when the user clicks a carrier card. Receives the full `CartCarrier` object. |

### Formatting and labels

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatPrice` | `(price: number) => string` | Formats as `EUR X.XX` | Override the default price formatter. |
| `labels` | `Record<string, string>` | — | Override UI strings. Supported keys: `noCarriers` (empty-state message), `deliveryDeadline` (prefix before the deadline value). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function Signature

```ts



const cartService = new CartService(graphqlClient);

// Fetch the cart with carriers
async function getCart(cartId: string): Promise<Cart>;

// Persist the selected carrier
async function setCarrier(cartId: string, carrierName: string): Promise<void>;
```

### Options Table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cartId` | `string` | — | `cart.cartId` — identifies the cart |
| `carrierName` | `string` | — | `carrier.name` — the selected carrier's name |

### Callbacks Table

| Callback | When it fires | What to implement |
|---|---|---|
| `onCarrierSelect` | User clicks a carrier card | Persist the selection via `CartService.setCarrier(cartId, carrier.name)`. Optionally refresh the cart to get updated `postageData`. |

### UI-Only Props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showCarrierLogo` — show/hide carrier logo images
- `showPrice` — show/hide carrier shipping prices
- `carriersContainerClass` — CSS class for the wrapper element
- `formatPrice` — custom price formatting function
- `labels` — customizable UI strings (`noCarriers`, `deliveryDeadline`)

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Used in |
|-----|---------|---------|
| `noCarriers` | *(empty-state message)* | Shown when `cart.carriers` is empty or undefined |
| `deliveryDeadline` | *(prefix before the deadline value)* | Displayed before the carrier's delivery deadline |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  noCarriers: 'No carriers available',
  deliveryDeadline: 'Delivery deadline:',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- Renders a responsive grid of carrier cards (1 column on mobile, 2 on small screens, 3 on large).
- Clicking a card selects it visually (highlighted border and background) and fires `onCarrierSelect`.
- Only one carrier can be selected at a time; selecting a new one deselects the previous.
- Selection is local UI state only. The component does not call the API -- the parent must handle persistence via `onCarrierSelect`.
- When `cart.carriers` is empty or missing, an empty-state message is shown (customizable via `labels.noCarriers`).
- Carrier logos are displayed as small images (`h-6`) when `showCarrierLogo` is true and the carrier has a `logo` URL.
- The `deliveryDeadline` line only appears for carriers that have that field set.
- Prices default to EUR formatting (`EUR X.XX`) and can be overridden with `formatPrice`.

## GraphQL

### Query: cart with carriers

```graphql
query CartWithCarriers($cartId: String!) {
  cart(cartId: $cartId) {
    cartId
    carriers {
      name
      price
      logo
      deliveryDeadline
    }
    postageData {
      price
      carrier
    }
  }
}
```

### Mutation: set carrier on cart

```graphql
mutation SetCartCarrier($cartId: String!, $carrier: String!) {
  cartSetCarrier(input: { cartId: $cartId, carrier: $carrier }) {
    cartId
    postageData {
      price
      carrier
    }
  }
}
```

## SDK Services

CartCarriers is a presentation-only component. It reads carriers from the `Cart` object but does not call the SDK itself. The parent is responsible for fetching the cart (which includes carriers) and for persisting the user's selection.

### Fetching a cart with carriers

Use `CartService.getCart()` to retrieve a cart. The response includes the `carriers` array when the backend has shipping options configured for the cart's contents and delivery address.

```ts


const cartService = new CartService(graphqlClient);
const cart = await cartService.getCart(cartId);
// cart.carriers -> CartCarrier[]
```

### Setting the selected carrier

After the user selects a carrier via `onCarrierSelect`, persist the choice back to the API:

```ts
await cartService.setCarrier(cartId, carrier.name);
```

This updates the cart server-side so that `cart.postageData` reflects the selected carrier's shipping cost.

---

## CartIconAndSidebar

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-icon-and-sidebar

# CartIconAndSidebar

A shopping cart icon with item count badge, hover totals tooltip, and a slide-in sidebar that displays cart contents. Designed for use in site headers.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Header icon with sidebar and totals tooltip

```tsx


function Header() {
  const { cart } = useCart();
  const router = useRouter();

  return (
    <CartIconAndSidebar
      cart={cart}
      showTotals={true}
      showBadge={true}
      cartCheckoutButton={true}
      cartPageButton={true}
      onCheckoutButtonClick={() => router.push('/checkout')}
      onCartPageButtonClick={() => router.push('/cart')}
    />
  );
}
```

### Header icon with sidebar, no hover totals

```tsx
<CartIconAndSidebar
  cart={cart}
  showTotals={false}
  onCheckoutButtonClick={() => router.push('/checkout')}
  onCartPageButtonClick={() => router.push('/cart')}
/>
```

### Icon-only (no sidebar, custom click handler)

When `showCartSidebarOnClick` is `false`, clicking the icon fires `onCartIconClick` instead of opening the sidebar. Useful when you want to navigate directly to the cart page.

```tsx
<CartIconAndSidebar
  cart={cart}
  showCartSidebarOnClick={false}
  onCartIconClick={(cart) => router.push('/cart')}
/>
```

### Custom labels

```tsx
<CartIconAndSidebar
  cart={cart}
  cartSidebarTitle="Your Bag"
  labels={{
    totalLabel: 'Subtotal',
    itemsLabel: 'products',
    emptyCart: 'Nothing here yet.',
    continueShopping: 'Keep Browsing',
    qty: 'Quantity',
    total: 'Order Total',
    checkoutButton: 'Proceed to Checkout',
    cartPageButton: 'View Full Cart',
    cartIconLabel: 'Open cart',
    closeLabel: 'Close cart',
  }}
  onCheckoutButtonClick={() => router.push('/checkout')}
  onCartPageButtonClick={() => router.push('/cart')}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a standalone cart icon with sidebar, you need to read from the `Cart` object and manage two pieces of UI state.

### Basic cart data access

```ts


// --- Cart data access ---
const itemCount = cart?.items?.length ?? 0;
const totalPrice = cart?.total?.totalNet ?? 0;

// Per-item data mapping:
// - Name:  item.product?.names?.[0]?.value
// - Image: item.product?.media?.images?.items?.[0]?.imageVariants?.[0]?.url
//          (use an SVG placeholder when the URL is missing or does not start with "http")
// - Qty:   item.quantity
// - Price: item.totalSumNet
```

### Icon-only (no sidebar, custom click handler)

```ts
// When not using a sidebar, simply track the item count and navigate on click:
const itemCount = cart?.items?.length ?? 0;

function onCartIconClick(cart: Cart) {
  // Navigate to the cart page
  // Not documented in source — implement based on your setup
}
```

### Full sidebar implementation

**State to track:**

- `sidebarOpen` (boolean) -- controls whether the sidebar panel is visible.
- `mounted` (boolean) -- a hydration guard flag, initialized to `false`, set to `true` after the component mounts on the client. Wrap the badge and the sidebar content area behind this flag so that server-rendered HTML does not include cart data from `localStorage`.

**Hydration note:** Because cart data typically comes from `localStorage`, it is not available during server-side rendering. Any element that displays cart-derived values (item count badge, item list, totals) must be guarded so it only renders after the component has mounted on the client. This prevents mismatches between server and client HTML.

**UI structure:**

- **Icon button** with a cart icon. When `sidebarOpen` is false and the item count is greater than zero (and the component has mounted), show a count badge.
- **Overlay** behind the sidebar, clicking it closes the sidebar.
- **Sidebar panel** that slides in from the right. Contains a header with title and close button, a scrollable list of cart items (filter out items without a `product`), and a footer with the total price and checkout/cart-page buttons.
- **Empty state** when the cart has no items, show an empty cart message with a "Continue Shopping" action that closes the sidebar.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `cart` | `Cart` | *required* | The cart object from Propeller SDK. |

### Icon & Badge

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showBadge` | `boolean` | `true` | Show item count badge on the cart icon. |
| `showTotals` | `boolean` | `false` | Show a totals tooltip when hovering the icon. |
| `iconClassName` | `string` | — | Additional CSS class for the icon button. |

### Sidebar

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showCartSidebarOnClick` | `boolean` | `true` | Open the sidebar on icon click. When `false`, fires `onCartIconClick` instead. |
| `cartSidebarTitle` | `string` | `'Shopping cart'` | Title displayed at the top of the sidebar. |
| `cartCheckoutButton` | `boolean` | `true` | Show the checkout button in the sidebar footer. |
| `cartPageButton` | `boolean` | `true` | Show the "View Cart Details" button in the sidebar footer. |
| `sidebarClassName` | `string` | — | Additional CSS class for the sidebar panel. |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onCartIconClick` | `(cart: Cart) => void` | Fired on icon click when `showCartSidebarOnClick` is `false`. |
| `onCheckoutButtonClick` | `(cart: Cart) => void` | Fired when the checkout button in the sidebar is clicked. |
| `onCartPageButtonClick` | `(cart: Cart) => void` | Fired when the cart page button in the sidebar is clicked. |

### Labels

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `labels` | `Record<string, string>` | — | Override any UI text. Keys: `cartIconLabel`, `totalLabel`, `itemsLabel`, `emptyCart`, `continueShopping`, `qty`, `total`, `checkoutButton`, `cartPageButton`, `closeLabel`, `cartSidebarTitle`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function Signature

```ts


// This component is display-only. It receives a Cart object and reads fields from it.
// No SDK service calls are made internally.

// Primary data access:
const itemCount: number = cart?.items?.length ?? 0;
const totalPrice: number = cart?.total?.totalNet ?? 0;
```

### Options Table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cart` | `Cart` | — | The cart object; reads `cart.items`, `cart.total.totalNet` |

### Callbacks Table

| Callback | When it fires | What to implement |
|---|---|---|
| `onCartIconClick` | Icon clicked when sidebar is disabled | Navigate to the cart page or open a custom cart view. |
| `onCheckoutButtonClick` | Checkout button clicked in sidebar | Navigate to the checkout page. |
| `onCartPageButtonClick` | Cart page button clicked in sidebar | Navigate to the full cart page. |

### UI-Only Props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showBadge` — show/hide item count badge
- `showTotals` — show/hide hover totals tooltip
- `iconClassName` — CSS class for the icon button
- `showCartSidebarOnClick` — whether clicking the icon opens the sidebar
- `cartSidebarTitle` — sidebar header title
- `cartCheckoutButton` — show/hide checkout button in sidebar
- `cartPageButton` — show/hide cart page button in sidebar
- `sidebarClassName` — CSS class for the sidebar panel
- `labels` — customizable UI strings

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Used in |
|-----|---------|---------|
| `cartIconLabel` | *(cart icon label)* | Accessibility label for the cart icon button |
| `totalLabel` | *(total label)* | Label for the total price in the hover tooltip |
| `itemsLabel` | *(items label)* | Label for the item count in the hover tooltip |
| `emptyCart` | *(empty cart message)* | Message shown when the cart has no items |
| `continueShopping` | *(continue shopping text)* | Link text in the empty cart state |
| `qty` | *(quantity label)* | Label prefix for item quantity |
| `total` | *(total label)* | Label for the total price in the sidebar footer |
| `checkoutButton` | *(checkout button text)* | Checkout button label |
| `cartPageButton` | *(cart page button text)* | Cart page button label |
| `closeLabel` | *(close label)* | Close button accessibility label |
| `cartSidebarTitle` | *(sidebar title)* | Sidebar header title |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  cartIconLabel: 'Open cart',
  totalLabel: 'Total',
  itemsLabel: 'items',
  emptyCart: 'Your cart is empty.',
  continueShopping: 'Continue Shopping',
  qty: 'Qty',
  total: 'Total',
  checkoutButton: 'Checkout',
  cartPageButton: 'View Cart Details',
  closeLabel: 'Close cart',
  cartSidebarTitle: 'Shopping cart',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Icon badge

The badge displays the number of items in `cart.items`. It only renders when `showBadge` is `true` (the default) and the item count is greater than zero. The badge is hidden during server-side rendering and appears only after the component mounts (see Hydration guard below).

### Sidebar open/close

- **Opening**: Clicking the cart icon opens the sidebar by default (`showCartSidebarOnClick={true}`). When set to `false`, the icon click fires `onCartIconClick` instead.
- **Closing**: The sidebar closes when clicking the dark overlay behind it, clicking the close (X) button, or when a checkout/cart-page button is clicked (callbacks fire after the sidebar closes).
- **Animation**: The sidebar slides in from the right with a 300ms CSS transition. The overlay uses `backdrop-blur-sm` for a blurred background effect.
- **Empty state**: When the cart has no items, the sidebar shows an empty cart message with a "Continue Shopping" link that closes the sidebar.

### Hover totals tooltip

When `showTotals` is `true`, hovering over the cart icon shows a small tooltip with the total price and item count. The tooltip appears below the icon and right-aligned.

### Image fallback

When a product has no image URL (or the URL does not start with `http`), the component renders an inline SVG placeholder (a landscape/image icon) instead of a broken `<img>` tag. No external fallback image file is needed.

### Bundle items

Cart items that contain bundle data (`item.bundle`) render differently from regular items. The bundle name and total price appear at the top, followed by an indented list showing the bundle leader product first, then remaining bundle items with their individual prices.

### Hydration guard

The component uses an `_isMounted` state flag that starts as `false` and flips to `true` after the component mounts on the client. The item count badge and the entire sidebar content area are wrapped in a mount guard, preventing hydration mismatches when cart data comes from `localStorage` (which is unavailable during SSR).

## Cart Data (SDK Fields Read)

This component is display-only. It receives a `Cart` object as a prop and reads the following fields:

| Field | Type | Used For |
|-------|------|----------|
| `cart.items` | `CartMainItem[]` | List of line items displayed in the sidebar. Item count for the badge. |
| `cart.total.totalNet` | `number` | Total price (incl. VAT) shown in the hover tooltip and sidebar footer. |
| `item.product.names[0].value` | `string` | Product display name. |
| `item.product.media.images.items[0].imageVariants[0].url` | `string` | Product thumbnail in the sidebar. |
| `item.product.slugs[0].value` | `string` | Used to build product/cluster URLs. |
| `item.product.sku` | `string` | SKU displayed beneath the product name. |
| `item.product.class` | `Enums.ProductClass` | Determines URL format (`/product/...` vs `/cluster/...`). |
| `item.product.productId` / `item.product.clusterId` | `number` | Used in URL generation. |
| `item.quantity` | `number` | Displayed as "Qty: N". |
| `item.totalSumNet` | `number` | Line item total price (incl. VAT). |
| `item.childItems` | `CartBaseItem[]` | Cluster child items, displayed indented beneath the parent. |
| `item.bundle` | `Bundle` | Bundle data. When present, the item renders as a bundle with leader + non-leader items. |
| `item.bundle.name` | `string` | Bundle display name. |
| `item.bundle.price.net` | `number` | Bundle total price. |
| `item.bundle.items[].isLeader` | `Enums.YesNo` | Identifies the bundle leader product. |
| `item.bundle.items[].product.names[0].value` | `string` | Individual bundle item name. |
| `item.bundle.items[].price.net` | `number` | Individual bundle item price. |

---

## CartItem

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-item

# CartItem

A self-contained cart line item component that handles quantity updates, item deletion, notes, stock display, bundle items, cluster children, cross-sell suggestions, and VAT-aware pricing -- all via the Propeller SDK.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic Cart Item

```tsx




<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={item}
  configuration={config}
  afterCartUpdate={(updatedCart) => saveCart(updatedCart)}
/>
```

### With Cross-Sell Accessories

Fetches and displays related products beneath the cart item on mount. Cross-sell results are rendered as compact thumbnail cards.

```tsx
<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={item}
  configuration={config}
  user={authState.user}
  taxZone="NL"
  showCrossupsells={true}
  crossupsellTypes={['ACCESSORIES', 'RELATED']}
  crossupsellLimit={4}
  onCrossupsellClick={(product) => router.push(config.urls.getProductUrl(product))}
  afterCartUpdate={(updatedCart) => saveCart(updatedCart)}
/>
```

### With Notes Field

Enables a per-item textarea for customer notes. Notes are debounced (500 ms) before being persisted to the cart.

```tsx
<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={item}
  configuration={config}
  showCartItemNotesField={true}
  afterCartUpdate={(updatedCart) => saveCart(updatedCart)}
/>
```

### Cluster Children (Included Options)

When a cart item belongs to a cluster (`cartItem.clusterId` is set and `cartItem.childItems` has entries), the component automatically renders child items beneath the product name with their SKU and price.

```tsx
{/* No extra props needed -- cluster children render automatically */}
<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={clusterItem}
  configuration={config}
  afterCartUpdate={(updatedCart) => saveCart(updatedCart)}
/>
```

### Full-Featured Example

```tsx
<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={item}
  configuration={config}
  user={authState.user}
  taxZone="NL"
  language="EN"
  showStockComponent={true}
  showCartItemNotesField={true}
  showSku={true}
  enableIncrementDecrement={true}
  showCrossupsells={true}
  crossupsellTypes={['ACCESSORIES']}
  crossupsellLimit={3}
  includeTax={true}
  labels={{
    notes: 'Item notes',
    notesPlaceholder: 'Special instructions...',
    includedOptions: 'Selected options:',
    crossupsellTitle: 'Frequently bought together',
    updating: 'Saving...',
  }}
  afterCartUpdate={(updatedCart) => saveCart(updatedCart)}
/>
```

### Delegation Mode (External Cart Mutations)

When `onQuantityChange`, `onNoteChange`, or `onDelete` callbacks are provided, the component delegates those operations to the parent instead of calling CartService internally.

```tsx
<CartItem
  graphqlClient={graphqlClient}
  cartId={cart.cartId}
  cartItem={item}
  configuration={config}
  onQuantityChange={(item, qty) => myCustomUpdate(item.itemId, qty)}
  onNoteChange={(item, note) => myCustomNoteUpdate(item.itemId, note)}
  onDelete={(item) => myCustomDelete(item.itemId)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

A standalone implementation of a cart item row requires three SDK operations: update quantity, update notes, and delete.

```ts


// pseudo-code

const cartService = new CartService(graphqlClient);
const language = 'NL';

// --- Reading item data ---
const productName = cartItem.product?.names?.[0]?.value || 'Product';
const productSku = cartItem.product?.sku || '';
const price = cartItem.totalSum || 0;
const imageUrl = cartItem.product?.media?.images?.items?.[0]?.imageVariants?.[0]?.url;

// --- Update quantity ---
// Call immediately on +/- click. On failure, revert to the original quantity.
async function updateQuantity(cartId: string, cartItem: CartMainItem, newQty: number): Promise<Cart> {
  return await cartService.updateCartItem({
    id: cartId,
    itemId: cartItem.itemId.toString(),
    input: { quantity: newQty },
    language,
  });
}

// --- Update notes ---
// Use a debounce pattern: reset a timer on each keystroke, then call the API
// after 500ms of inactivity. Store the timer reference so it can be cleared
// on subsequent keystrokes.
async function updateNotes(cartId: string, cartItem: CartMainItem, notes: string): Promise<Cart> {
  return await cartService.updateCartItem({
    id: cartId,
    itemId: cartItem.itemId.toString(),
    input: { notes },
    language,
  });
}

// --- Delete item ---
// Disable the delete button while the request is in progress to prevent
// duplicate calls.
async function deleteItem(cartId: string, cartItem: CartMainItem): Promise<Cart> {
  return await cartService.deleteCartItem({
    id: cartId,
    itemId: cartItem.itemId,
    input: { itemId: cartItem.itemId },
    language,
  });
}
```

### With Cross-Sell Accessories

```ts


const crossupsellService = new CrossupsellService(graphqlClient);

// Fetch cross-sells for a cart item's product
const crossupsells = await crossupsellService.getCrossupsells({
  types: ['ACCESSORIES', 'RELATED'],
  productIdsFrom: [cartItem.product.productId],
  page: 1,
  offset: 50,
});

// For cluster products, use clusterIdsFrom instead:
// const crossupsells = await crossupsellService.getCrossupsells({
//   types: ['ACCESSORIES'],
//   clusterIdsFrom: [cartItem.clusterId],
//   page: 1,
//   offset: 50,
// });

// Limit the displayed results
const limitedItems = crossupsells?.items?.slice(0, 4) || [];
```

### Delegation Mode (External Cart Mutations)

```ts
// When you want to handle cart mutations externally instead of using CartService:
// Provide your own update/delete handlers and skip the SDK calls.

function handleQuantityChange(item: CartMainItem, quantity: number): void {
  // Your custom quantity update logic
}

function handleNoteChange(item: CartMainItem, note: string): void {
  // Your custom note update logic
}

function handleDelete(item: CartMainItem): void {
  // Your custom delete logic
}
```

**UI structure:** Render each cart item as a row with a product image (or SVG placeholder if no image), product name, SKU, a quantity input with +/- buttons, the line total price, a notes textarea, and a delete button. Track `quantity`, `notes`, and loading/deleting flags in your framework's state mechanism. After each successful SDK call, forward the returned `Cart` object to your app's cart state so totals stay in sync.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `graphqlClient` | `GraphQLClient` | Propeller SDK GraphQL client instance |
| `cartId` | `string` | Shopping cart unique identifier |
| `cartItem` | `CartMainItem` | The cart line item to render |

### Display Options

| Prop | Type | Default | Description |
|---|---|---|---|
| `titleLinkable` | `boolean` | `true` | Make the item title a link to the product detail page |
| `showStockComponent` | `boolean` | `false` | Show stock availability via the ItemStock component |
| `showSku` | `boolean` | `true` | Display the product SKU beneath the item name |
| `enableIncrementDecrement` | `boolean` | `true` | Show +/- buttons around the quantity input |
| `showCartItemNotesField` | `boolean` | `false` | Show a notes textarea for the item |
| `includeTax` | `boolean` | `false` | Display prices including VAT (`totalSumNet`) or excluding VAT (`totalSum`) |
| `className` | `string` | -- | Additional CSS class for the root element |

### Cross-Sell Options

| Prop | Type | Default | Description |
|---|---|---|---|
| `showCrossupsells` | `boolean` | `false` | Enable cross-sell/upsell product suggestions below the item |
| `crossupsellTypes` | `string[]` | `['ACCESSORIES']` | Which cross-sell types to fetch: `'ACCESSORIES'`, `'ALTERNATIVES'`, `'OPTIONS'`, `'PARTS'`, `'RELATED'` |
| `crossupsellLimit` | `number` | `3` | Maximum number of cross-sell products to display |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onQuantityChange` | `(item: CartMainItem, quantity: number) => void` | Override internal quantity update -- CartService is NOT called when provided |
| `onNoteChange` | `(item: CartMainItem, note: string) => void` | Override internal note update -- CartService is NOT called when provided |
| `onDelete` | `(item: CartMainItem) => void` | Override internal delete -- CartService is NOT called when provided |
| `afterCartUpdate` | `(cart: Cart) => void` | Called after any successful internal CartService mutation; use to sync cart state with your app |
| `onCrossupsellClick` | `(product: Product \| Cluster) => void` | Override default navigation when a cross-sell product is clicked |

### Configuration

| Prop | Type | Default | Description |
|---|---|---|---|
| `configuration` | `any` | -- | App config object providing `imageSearchFiltersGrid`, `imageVariantFiltersSmall`, `imageVariantFiltersMedium`, and `urls.getProductUrl()` |
| `language` | `string` | `'NL'` | Language code passed to CartService and CrossupsellService operations |
| `taxZone` | `string` | `'NL'` | Tax zone for cross-sell price calculations |
| `user` | `Contact \| Customer \| null` | -- | Authenticated user; used for cross-sell price calculations (company/contact/customer IDs) |
| `labels` | `Record<string, string>` | -- | Override UI strings (see Labels section) |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


const cartService = new CartService(graphqlClient);

// Update quantity or notes
async function updateCartItem(params: {
  id: string;            // cartId
  itemId: string;        // cartItem.itemId
  input: { quantity?: number; notes?: string };
  language: string;
}): Promise<Cart>

// Delete item
async function deleteCartItem(params: {
  id: string;            // cartId
  itemId: string;        // cartItem.itemId
  input: { itemId: string };
  language: string;
}): Promise<Cart>

// Fetch cross-sells
const crossupsellService = new CrossupsellService(graphqlClient);
async function getCrossupsells(input: {
  types: string[];
  productIdsFrom?: number[];
  clusterIdsFrom?: number[];
  page?: number;
  offset?: number;
}): Promise<CrossupsellsResponse>
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cartId` | `string` | -- | `id` parameter in `updateCartItem` / `deleteCartItem` |
| `cartItem` | `CartMainItem` | -- | Source of `itemId`, product data, pricing, child items |
| `language` | `string` | `'NL'` | `language` parameter in CartService and CrossupsellService calls |
| `taxZone` | `string` | `'NL'` | Tax zone for cross-sell price calculations |
| `user` | `Contact \| Customer \| null` | -- | Used to build price calculation input for cross-sells (company/contact/customer IDs) |
| `crossupsellTypes` | `string[]` | `['ACCESSORIES']` | `types` in `getCrossupsells` input |
| `crossupsellLimit` | `number` | `3` | Limits how many cross-sell results to display |
| `includeTax` | `boolean` | `false` | Selects `totalSumNet` (true) or `totalSum` (false) from cart item |

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onQuantityChange` | User changes quantity (overrides internal CartService call) | Call your own cart update logic with the item and new quantity |
| `onNoteChange` | User changes notes (overrides internal CartService call) | Call your own cart update logic with the item and new note text |
| `onDelete` | User clicks delete (overrides internal CartService call) | Call your own cart delete logic with the item |
| `afterCartUpdate` | After any successful internal CartService mutation | Sync the returned `Cart` object with your app's cart state |
| `onCrossupsellClick` | User clicks a cross-sell product | Navigate to the product detail page or handle as needed |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `titleLinkable` -- make the item title a clickable link
- `showStockComponent` -- show/hide stock indicator
- `showSku` -- show/hide product SKU
- `enableIncrementDecrement` -- show/hide +/- buttons around quantity input
- `showCartItemNotesField` -- show/hide notes textarea
- `showCrossupsells` -- show/hide cross-sell section
- `className` -- CSS class for styling
- `labels` -- UI string overrides
- `configuration` -- app config for image filters and URL generation

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `remove` | `'Remove'` | Delete button text |
| `deleting` | `'Removing...'` | Delete button text while removing |
| `updating` | `'Updating...'` | Shown next to quantity controls during update |
| `notes` | `'Notes'` | Notes field label |
| `notesPlaceholder` | `'Add a note for this item...'` | Notes textarea placeholder |
| `includedOptions` | `'Included Options:'` | Heading above cluster child items |
| `crossupsellTitle` | `'You might also like'` | Cross-sell section heading |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  remove: 'Remove',
  deleting: 'Removing...',
  updating: 'Updating...',
  notes: 'Notes',
  notesPlaceholder: 'Add a note for this item...',
  includedOptions: 'Included Options:',
  crossupsellTitle: 'You might also like',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Quantity Controls

- By default, +/- buttons are shown around a numeric input (`enableIncrementDecrement={true}`).
- Setting `enableIncrementDecrement={false}` renders a plain number input without buttons.
- Minimum quantity is 1; the minus button is disabled at that value.
- On change, `CartService.updateCartItem()` is called immediately (no debounce). If the API call fails, the quantity reverts to the original value.
- While the update is in progress, the `loading` state disables the controls and shows the `updating` label.

### Delete

- Clicking the trash icon calls `CartService.deleteCartItem()`.
- A spinner replaces the icon while the deletion is in progress, and the button is disabled to prevent duplicate calls.
- The updated cart is forwarded to `afterCartUpdate`.

### Notes

- When `showCartItemNotesField={true}`, a textarea appears below the product info.
- Changes are debounced at 500 ms before calling `CartService.updateCartItem()` with the `notes` field.
- The debounce timer resets on each keystroke.

### Price Display

- Prices are formatted as EUR with two decimal places.
- When `includeTax` is `true`, the component uses `totalSumNet` (price including VAT).
- When `includeTax` is `false` (default), it uses `totalSum` (price excluding VAT).
- The component also listens for the `priceToggleChanged` custom event and reads `price_include_tax` from `localStorage` to stay in sync with the global VAT toggle.

### Stock Display

- When `showStockComponent={true}` and the product has `inventory` data, a stock status indicator is rendered.
- The compiled React copy uses the `ItemStock` component directly; the base component outputs a data-attribute placeholder for framework-specific rendering.

### Bundle Items

- When `cartItem.bundle` is present, the component renders the bundle name as the title instead of the product name.
- Bundle items are listed beneath the title: the leader item is shown first (bold), followed by non-leader items. Each shows name and price connected by a dotted line.
- The SKU line is hidden for bundle items.

### Cluster Children

- When `cartItem.clusterId` is set and `cartItem.childItems` contains entries, an "Included Options" section renders automatically.
- Each child item shows its name, SKU, and price in a bordered list.

### Cross-Sells

- When `showCrossupsells={true}`, the component fetches cross-sell products on mount via `CrossupsellService.getCrossupsells()`.
- Products are fetched using `productIdsFrom` (for simple products) or `clusterIdsFrom` (for cluster products).
- Results are displayed as horizontally scrollable compact cards with thumbnail and name, limited by `crossupsellLimit` (default 3).
- Clicking a cross-sell navigates to the product page, or calls `onCrossupsellClick` if provided.
- Errors are caught silently -- the section simply does not appear.

---

## GraphQL Query and Mutation Examples

### Update Cart Item Quantity

```graphql
mutation UpdateCartItem($id: String!, $itemId: String!, $input: CartItemUpdateInput!) {
  cartUpdateItem(id: $id, itemId: $itemId, input: $input) {
    cartId
    items {
      itemId
      quantity
      totalSum
      totalSumNet
      product {
        productId
        sku
        names { value }
      }
    }
    total {
      subTotal
      totalNet
      totalGross
    }
  }
}
```

Variables:

```json
{
  "id": "cart-abc-123",
  "itemId": "456",
  "input": { "quantity": 3 }
}
```

### Update Cart Item Notes

```json
{
  "id": "cart-abc-123",
  "itemId": "456",
  "input": { "notes": "Please gift wrap this item" }
}
```

### Delete Cart Item

```graphql
mutation DeleteCartItem($id: String!, $itemId: String!, $input: CartItemDeleteInput!) {
  cartDeleteItem(id: $id, itemId: $itemId, input: $input) {
    cartId
    items {
      itemId
      quantity
    }
    total {
      subTotal
      totalNet
      totalGross
    }
  }
}
```

Variables:

```json
{
  "id": "cart-abc-123",
  "itemId": "456",
  "input": { "itemId": "456" }
}
```

### Fetch Cross-Sells

```graphql
query Crossupsells($input: CrossupsellSearchInput!, $language: String) {
  crossupsells(input: $input, language: $language) {
    items {
      crossupsellId
      type
      productTo {
        productId
        names { value }
        media {
          images {
            items {
              imageVariants { url }
            }
          }
        }
      }
      clusterTo {
        clusterId
        names { value }
      }
    }
  }
}
```

Variables:

```json
{
  "input": {
    "types": ["ACCESSORIES"],
    "productIdsFrom": [12345],
    "page": 1,
    "offset": 50
  },
  "language": "NL"
}
```

---

## SDK Services

The component uses the following `propeller-sdk-v2` services internally:

### CartService

Used for quantity updates and item deletion. Each mutation returns the full updated `Cart` object, which is forwarded to `afterCartUpdate`.

- **`CartService.updateCartItem()`** -- updates quantity or notes for a cart item
- **`CartService.deleteCartItem()`** -- removes an item from the cart

### CrossupsellService

Used to fetch cross-sell/upsell suggestions when `showCrossupsells` is enabled.

- **`CrossupsellService.getCrossupsells()`** -- fetches related products by `productIdsFrom` or `clusterIdsFrom`, filtered by `types` (e.g., `ACCESSORIES`, `RELATED`)

> **Known SDK issue**: `CrossupsellService.getCrossupsells()` may return an HTTP 400 due to undeclared fragment variables in the SDK's internal query. The error is caught silently, and no cross-sells are displayed. This will resolve when the SDK is updated.

### ItemStock (via parent)

Stock display relies on the `ItemStock` component rendered by the parent React copy. When `showStockComponent={true}` and the product has `inventory` data, a stock indicator is shown.

---

## CartOverview

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-overview

# CartOverview

Renders a structured checkout summary displaying invoice and delivery addresses, payment and shipping details, optional reference and notes fields, terms and conditions acceptance, and a purchase button.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic checkout overview

```tsx


<CartOverview
  graphqlClient={graphqlClient}
  cart={cart}
  onPurchaseButtonClick={(cart, reference, notes) => handlePlaceOrder(reference, notes)}
/>
```

### With custom labels and terms link

```tsx
<CartOverview
  graphqlClient={graphqlClient}
  cart={cart}
  title="Order Summary"
  labels={{
    invoiceAddress: 'Billing Address',
    deliveryAddress: 'Shipping Address',
    payment: 'Payment Method:',
    carrier: 'Shipping Provider:',
    deliveryDate: 'Expected Delivery:',
    referenceLabel: 'PO Number (Optional)',
    referencePlaceholder: 'Enter your PO number',
    notesLabel: 'Comments (Optional)',
    notesPlaceholder: 'Any special delivery instructions?',
    termsPrefix: 'I accept the',
    termsLink: 'General Terms & Conditions',
    purchaseButton: 'Confirm Order',
    processing: 'Placing order...',
  }}
  onTermsAndConditionsClick={() => window.open('/terms-conditions', '_blank')}
  onPurchaseButtonClick={(cart, reference, notes) => handlePlaceOrder(reference, notes)}
/>
```

### Minimal read-only summary (no inputs, no purchase button)

```tsx
<CartOverview
  graphqlClient={graphqlClient}
  cart={cart}
  title="Your Order"
  showNotes={false}
  showReference={false}
  showTermsAndConditions={false}
  showPurchaseButton={false}
/>
```

### B2B checkout with reference required

```tsx
<CartOverview
  graphqlClient={graphqlClient}
  cart={cart}
  title="Place B2B Order"
  showNotes={true}
  showReference={true}
  labels={{
    referenceLabel: 'Purchase Order Number',
    referencePlaceholder: 'PO-00000',
  }}
  onPurchaseButtonClick={(cart, reference, notes) => {
    if (!reference) {
      toast.error('Please enter a PO number');
      return;
    }
    submitOrder(cart, reference, notes);
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom checkout overview that replaces this component:

1. **Read the Cart object** — all data comes from the `Cart` type in `propeller-sdk-v2`. No additional API calls are needed for the overview itself.

2. **Address formatting** — access `cart.invoiceAddress` and `cart.deliveryAddress`. Both are `CartAddress` objects with the fields listed above. Render them in whatever layout suits your design.

3. **Payment and shipping info** — read `cart.paymentData.method`, `cart.postageData.carrier`, and `cart.postageData.requestDate`. These are set during earlier checkout steps.

4. **Order submission** — collect any user inputs (reference, notes, terms acceptance) and pass them along with the cart to your order placement logic. The component itself does not call any order API; that responsibility belongs to the parent.

5. **Loading state** — manage your own loading indicator. This component sets loading internally on button click but has no way to reset it. If you need retry or error recovery, manage loading state in the parent.

6. **Labels** — if you need i18n, pass translated strings through the `labels` prop or implement your own translation layer in a custom component.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `graphqlClient` | `GraphQLClient` | GraphQL client instance for the Propeller SDK |
| `cart` | `Cart` | The shopping cart object containing addresses, payment data, and postage data |

### Display toggles

| Prop | Type | Default | Description |
|---|---|---|---|
| `showNotes` | `boolean` | `true` | Show the order notes textarea |
| `showReference` | `boolean` | `true` | Show the reference/PO number input |
| `showTermsAndConditions` | `boolean` | `true` | Show the terms and conditions checkbox |
| `showPurchaseButton` | `boolean` | `true` | Show the "Place Order" button |

### Appearance

| Prop | Type | Default | Description |
|---|---|---|---|
| `overviewContainerClass` | `string` | `'cart-overview'` | CSS class applied to the root container |
| `title` | `string` | — | Optional heading displayed above the overview |
| `labels` | `Record<string, string>` | — | Override any default label text (see label keys below) |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onTermsAndConditionsClick` | `() => void` | Fires when the terms and conditions link is clicked (default click is prevented) |
| `onPurchaseButtonClick` | `(cart: Cart, reference: string, notes: string) => void` | Fires when the purchase button is clicked; receives the cart, reference text, and notes text |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function cartOverview(cart: Cart): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cart` | `Cart` | — | `cart` prop |
| `title` | `string` | `undefined` | `title` prop |
| `showNotes` | `boolean` | `true` | `showNotes` prop |
| `showReference` | `boolean` | `true` | `showReference` prop |
| `showTermsAndConditions` | `boolean` | `true` | `showTermsAndConditions` prop |
| `showPurchaseButton` | `boolean` | `true` | `showPurchaseButton` prop |

### Cart resolution

All data comes from the `Cart` object:

| Cart field | Used for |
|---|---|
| `cart.invoiceAddress` | Displays the billing address (company, name, street, postal code, city, country, email) |
| `cart.deliveryAddress` | Displays the shipping address (same fields as invoice address) |
| `cart.paymentData.method` | Shows the selected payment method name |
| `cart.postageData.carrier` | Shows the selected shipping carrier name |
| `cart.postageData.requestDate` | Shows the requested delivery date, formatted via `toLocaleDateString()` |

### Callbacks

| Callback | Signature | Description |
|---|---|---|
| `onTermsAndConditionsClick` | `() => void` | Fires when the terms link is clicked |
| `onPurchaseButtonClick` | `(cart: Cart, reference: string, notes: string) => void` | Fires when the purchase button is clicked |

### UI-only props

The following props only affect visual presentation and have no BYO equivalent: `overviewContainerClass`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All labels can be overridden through the `labels` prop using these keys:

| Key | Default value |
|---|---|
| `invoiceAddress` | `"Invoice Address"` |
| `deliveryAddress` | `"Delivery Address"` |
| `payment` | `"Payment:"` |
| `carrier` | `"Carrier:"` |
| `deliveryDate` | `"Delivery Date:"` |
| `referenceLabel` | `"Reference (Optional)"` |
| `referencePlaceholder` | `"Your reference number"` |
| `notesLabel` | `"Order Notes (Optional)"` |
| `notesPlaceholder` | `"Special instructions or comments"` |
| `termsPrefix` | `"I agree to the"` |
| `termsLink` | `"Terms and Conditions"` |
| `purchaseButton` | `"Place Order"` |
| `processing` | `"Processing..."` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  invoiceAddress: "Invoice Address",
  deliveryAddress: "Delivery Address",
  payment: "Payment:",
  carrier: "Carrier:",
  deliveryDate: "Delivery Date:",
  referenceLabel: "Reference (Optional)",
  referencePlaceholder: "Your reference number",
  notesLabel: "Order Notes (Optional)",
  notesPlaceholder: "Special instructions or comments",
  termsPrefix: "I agree to the",
  termsLink: "Terms and Conditions",
  purchaseButton: "Place Order",
  processing: "Processing...",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Address display
- Invoice and delivery addresses are rendered in a two-column grid (single column on mobile).
- Each address shows company name, full name, street line, postal code + city, country, and email when available.
- If an address has no `street` value, the entire address block is hidden.

### Payment, carrier, and delivery date
- Displayed in a summary card below the addresses.
- Each row only appears when the corresponding cart field has a value.

### Reference and notes
- Both fields are managed as internal component state.
- Values are passed to `onPurchaseButtonClick` when the user submits the order.
- Either field can be hidden independently via `showReference` and `showNotes`.

### Terms and conditions
- When `showTermsAndConditions` is `true`, a checkbox must be checked before the purchase button becomes active.
- Clicking the "Terms and Conditions" link calls `onTermsAndConditionsClick` and prevents default navigation.

### Purchase button
- Disabled when terms are required but not yet accepted, or when `loading` is active.
- Clicking it sets an internal `loading` flag (shows a spinner and "Processing..." text) and fires `onPurchaseButtonClick`.
- The parent is responsible for resetting the component (e.g., navigating away on success or re-rendering on error).

## SDK Services and Cart Fields

CartOverview does not call any SDK services directly. It reads the following fields from the `Cart` object passed via props:

| Cart field | Used for |
|---|---|
| `cart.invoiceAddress` | Displays the billing address (company, name, street, postal code, city, country, email) |
| `cart.deliveryAddress` | Displays the shipping address (same fields as invoice address) |
| `cart.paymentData.method` | Shows the selected payment method name |
| `cart.postageData.carrier` | Shows the selected shipping carrier name |
| `cart.postageData.requestDate` | Shows the requested delivery date, formatted via `toLocaleDateString()` |

The `graphqlClient` prop is accepted for interface consistency with other components but is not used internally by CartOverview itself. The parent page is responsible for populating the `Cart` object with address and payment/postage data before passing it in.

### Related Cart types

```ts

```

- **`CartAddress`** — Contains `company`, `firstName`, `middleName`, `lastName`, `street`, `number`, `numberExtension`, `postalCode`, `city`, `country`, `email`
- **`cart.paymentData`** — Contains `method` (string)
- **`cart.postageData`** — Contains `carrier` (string), `requestDate` (date string)

---

## CartPaymethods

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-paymethods

# CartPaymethods

Displays available payment methods for a shopping cart and lets the user select one. Filters out invalid methods and hides "on account" options for guest users by default.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

```tsx


// Minimal — render payment methods from the cart
<CartPaymethods
  cart={cart}
  user={user}
  onPaymethodSelect={(method) => setSelectedPayment(method)}
/>
```

```tsx
// Custom price formatting and labels
<CartPaymethods
  cart={cart}
  user={user}
  onPaymethodSelect={(method) => handlePaymentSelect(method)}
  formatPrice={(price) => `USD ${price.toFixed(2)}`}
  labels={{ noMethods: 'No payment options found for your order.' }}
/>
```

```tsx
// Allow guest users to see "on account" payment methods
<CartPaymethods
  cart={cart}
  user={null}
  showOnAccountForGuests={true}
  onPaymethodSelect={(method) => handlePaymentSelect(method)}
/>
```

```tsx
// Custom container class for styling
<CartPaymethods
  cart={cart}
  user={user}
  paymentsContainerClass="my-custom-payments"
  onPaymethodSelect={(method) => handlePaymentSelect(method)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom payment method selector, you need:

1. **Read `cart.payMethods`** — an array of `CartPaymethod` objects, each with `code`, `name`, `price`, `externalCode`, and `type`.

2. **Filter methods** — remove entries without a `code`. Optionally hide "on account" methods (codes: `on_account`, `onaccount`, `on-account`) for guest users.

3. **Track selection** — store the selected `code` in local state and highlight the active card.

4. **Display surcharges** — when `method.price > 0`, show the cost next to the method name.

5. **Persist selection** — call `CartService.updateCart()` with `paymentData.method` set to the selected code so the backend records the choice before order placement.

```ts



// pseudo-code

// Filter payment methods
function getFilteredMethods(cart: Cart, user: Contact | Customer | null): CartPaymethod[] {
  const isGuest = !user;
  return (cart?.payMethods || []).filter((m) => {
    if (!m?.code) return false;
    const code = m.code.toLowerCase();
    if (isGuest && ['on_account', 'onaccount', 'on-account'].includes(code)) return false;
    return true;
  });
}

// Persist the selection to the API
async function selectPaymethod(cartId: string, method: CartPaymethod): Promise<void> {
  const cartService = new CartService(graphqlClient);
  await cartService.updateCart({
    cartId,
    paymentData: { method: method.code },
  });
}

const methods = getFilteredMethods(cart, user);

// Track the selected method code in your framework's state mechanism.
// Render a list of `methods`. For each method, display `method.name || method.code`.
// When `method.price > 0`, show a surcharge badge (e.g., "+EUR X.XX").
// On click, store the selected code and call `selectPaymethod(cart.cartId, method)`.
// If `methods` is empty, show a "No payment methods available." message.
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `cart` | `Cart` | Shopping cart object. Payment methods are read from `cart.payMethods`. |
| `user` | `Contact \| Customer \| null` | Authenticated user. Pass `null` for guest checkout. Used to determine guest vs. logged-in filtering. |

### Display

| Prop | Type | Default | Description |
|---|---|---|---|
| `paymentsContainerClass` | `string` | `'cart-paymethods'` | CSS class applied to the outer container. |
| `showOnAccountForGuests` | `boolean` | `false` | When `true`, "on account" methods remain visible for unauthenticated users. |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onPaymethodSelect` | `(paymethod: CartPaymethod) => void` | Fired when the user clicks a payment method card. Receives the full `CartPaymethod` object. |

### Formatting and Labels

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatPrice` | `(price: number) => string` | Formats as `€X.XX` | Override the default price formatter for method surcharges. |
| `labels` | `Record<string, string>` | — | Label overrides. Supported keys: `noMethods` (empty-state message, default: `"No payment methods available."`). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function cartPaymethods(cart: Cart, user: Contact | Customer | null): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cart` | `Cart` | — | `cart` prop |
| `user` | `Contact \| Customer \| null` | — | `user` prop |
| `showOnAccountForGuests` | `boolean` | `false` | `showOnAccountForGuests` prop |
| `formatPrice` | `(price: number) => string` | `€X.XX` | `formatPrice` prop |

### Cart resolution

Payment methods are read from `cart.payMethods`, an array of `CartPaymethod` objects:

| Field | Type | Purpose |
|---|---|---|
| `code` | `string` | Payment method identifier |
| `name` | `string` | Display name |
| `price` | `number` | Surcharge amount |
| `externalCode` | `string` | External system code |
| `type` | `string` | Payment type |

### Callbacks

| Callback | Signature | Description |
|---|---|---|
| `onPaymethodSelect` | `(paymethod: CartPaymethod) => void` | Fired when the user selects a payment method |

### UI-only props

The following props only affect visual presentation and have no BYO equivalent: `paymentsContainerClass`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default value |
|---|---|
| `noMethods` | `"No payment methods available."` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  noMethods: "No payment methods available.",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Filtering**: Methods without a `code` are excluded. "On account" variants (`on_account`, `onaccount`, `on-account`) are hidden for guest users unless `showOnAccountForGuests` is `true`.
- **Guest detection**: A user is considered a guest when `user` is `null`.
- **Selection highlight**: The selected method card receives a `border-secondary` border and a light background tint. Only one method can be selected at a time.
- **Price badge**: Methods with `price > 0` display a formatted surcharge badge. The default format is `€X.XX`; override with `formatPrice`.
- **Empty state**: When no methods pass filtering, a configurable message is shown (label key: `noMethods`).
- **Layout**: Methods render in a responsive grid — 1 column on mobile, 2 on `sm`, 3 on `lg`.

## SDK Services

CartPaymethods reads payment methods from the `Cart` object, which is populated by the Propeller SDK. The relevant services are:

### Fetching payment methods

Payment methods are included in the cart response when you fetch or start a cart via `CartService`:

```ts


const cartService = new CartService(graphqlClient);
const cart = await cartService.getCart({ cartId: 'abc-123' });

// cart.payMethods contains CartPaymethod[]
// Each CartPaymethod has: code, name, price, externalCode, type
```

### Setting the selected payment method

After the user selects a method (via `onPaymethodSelect`), persist it to the cart:

```ts


const cartService = new CartService(graphqlClient);
await cartService.updateCart({
  cartId: 'abc-123',
  paymentData: {
    method: selectedMethod.code,
  },
});
```

## GraphQL Queries and Mutations

### Query — cart with payment methods

```graphql
query Cart($cartId: String!) {
  cart(cartId: $cartId) {
    cartId
    payMethods {
      code
      name
      price
      externalCode
      type
    }
  }
}
```

### Mutation — set payment method on cart

```graphql
mutation CartUpdate($cartId: String!, $input: CartUpdateInput!) {
  cartUpdate(cartId: $cartId, input: $input) {
    cartId
    payMethods {
      code
      name
      price
    }
  }
}
```

Variables:

```json
{
  "cartId": "abc-123",
  "input": {
    "paymentData": {
      "method": "ideal"
    }
  }
}
```

---

## CartSummary

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/cart-summary

# CartSummary

Displays a structured overview of shopping cart totals: subtotal, discounts, shipping costs, VAT breakdowns, and the final total. Receives a `Cart` object as a prop and renders each line item with granular visibility controls. An optional checkout button can trigger navigation or custom checkout logic.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic summary with checkout button

```tsx


<CartSummary
  cart={cart}
  onCheckoutButtonClick={(cart) => router.push('/checkout')}
/>
```

### With checkout button and custom title

```tsx
<CartSummary
  cart={cart}
  title="Your Order"
  onCheckoutButtonClick={(cart) => router.push('/checkout')}
/>
```

### Read-only summary (no checkout button)

```tsx
<CartSummary
  cart={cart}
  showCheckoutButton={false}
/>
```

### Minimal summary (total only)

```tsx
<CartSummary
  cart={cart}
  showSubtotal={false}
  showDiscount={false}
  showShippingCosts={false}
  showVATs={false}
  showTotalExclVat={false}
  showTotalVat={false}
  showCheckoutButton={false}
/>
```

### Custom labels and price formatting

```tsx
<CartSummary
  cart={cart}
  labels={{
    subtotal: 'Subtotaal:',
    discount: 'Korting:',
    shippingCosts: 'Verzendkosten:',
    totalExclVat: 'Totaal excl. BTW:',
    vat: 'BTW',
    totalVat: 'Totaal BTW:',
    total: 'Totaal:',
    checkoutButton: 'Afrekenen',
  }}
  formatPrice={(price) => `$ ${price.toFixed(2)}`}
  onCheckoutButtonClick={(cart) => router.push('/checkout')}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

A standalone implementation that reads from the same `Cart` shape:

```tsx


function SimpleCartSummary({ cart }: { cart: Cart }) {
  const fmt = (n: number) => `€${(n || 0).toFixed(2)}`;

  const subtotal = cart?.total?.subTotal || 0;
  const discount = cart?.total?.discount || 0;
  const shipping = Number(cart?.postageData?.price || 0);
  const totalExclVat = cart?.total?.totalGross || 0;
  const totalInclVat = cart?.total?.totalNet || 0;
  const totalVat = totalInclVat - totalExclVat;
  const taxLevels = (cart?.taxLevels || []).filter(
    (t) => t.taxPercentage > 0 && t.price > 0
  );

  return (
    <div>
      <h2>Order Summary</h2>

      <div>Subtotal: {fmt(subtotal)}</div>

      {discount > 0 && <div>Discount: -{fmt(discount)}</div>}

      {shipping > 0 && <div>Shipping: {fmt(shipping)}</div>}

      <div>Total excl. VAT: {fmt(totalExclVat)}</div>

      {taxLevels.map((tax, i) => (
        <div key={i}>
          {tax.taxPercentage}% VAT: {fmt(Number(tax.price))}
        </div>
      ))}

      {totalVat > 0 && <div>Total VAT: {fmt(totalVat)}</div>}

      <div><strong>Total: {fmt(totalInclVat)}</strong></div>
    </div>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `cart` | `Cart` | Yes | -- | The shopping cart object used to populate all summary data |

### Display toggles

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showSubtotal` | `boolean` | `true` | Show the subtotal row |
| `showDiscount` | `boolean` | `true` | Show the discount row (only visible when a discount exists) |
| `showShippingCosts` | `boolean` | `true` | Show the shipping costs row (only visible when shipping costs exist) |
| `showVATs` | `boolean` | `true` | Show individual VAT level rows |
| `showTotalExclVat` | `boolean` | `true` | Show the total excluding VAT row |
| `showTotalVat` | `boolean` | `true` | Show the combined total VAT row |
| `showCheckoutButton` | `boolean` | `true` | Show the checkout button |

### Customization

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `title` | `string` | `'Order summary'` | Heading text above the summary |
| `labels` | `Record<string, string>` | See labels table below | Override any display label |
| `formatPrice` | `(price: number) => string` | Formats as `€X.XX` | Custom price formatting function |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onCheckoutButtonClick` | `(cart: Cart) => void` | Called when the checkout button is clicked. Receives the current cart object. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function cartSummary(cart: Cart): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cart` | `Cart` | — | `cart` prop |
| `title` | `string` | `'Order summary'` | `title` prop |
| `showSubtotal` | `boolean` | `true` | `showSubtotal` prop |
| `showDiscount` | `boolean` | `true` | `showDiscount` prop |
| `showShippingCosts` | `boolean` | `true` | `showShippingCosts` prop |
| `showVATs` | `boolean` | `true` | `showVATs` prop |
| `showTotalExclVat` | `boolean` | `true` | `showTotalExclVat` prop |
| `showTotalVat` | `boolean` | `true` | `showTotalVat` prop |
| `showCheckoutButton` | `boolean` | `true` | `showCheckoutButton` prop |
| `formatPrice` | `(price: number) => string` | `€X.XX` | `formatPrice` prop |

### Cart resolution

| Field | Type | Purpose |
|-------|------|---------|
| `cart.total.subTotal` | `number` | Line items subtotal before discounts |
| `cart.total.discount` | `number` | Total discount amount applied to the cart |
| `cart.total.totalGross` | `number` | Cart total excluding VAT |
| `cart.total.totalNet` | `number` | Cart total including VAT (the final price) |
| `cart.postageData.price` | `number` | Shipping / postage costs |
| `cart.taxLevels` | `Array<{ taxPercentage: number; price: number }>` | Individual VAT rates and their amounts |

The total VAT amount is computed as `totalNet - totalGross` (not read from a single field).

### Callbacks

| Callback | Signature | Description |
|---|---|---|
| `onCheckoutButtonClick` | `(cart: Cart) => void` | Called when the checkout button is clicked |

### UI-only props

The following props only affect visual presentation and have no BYO equivalent: `title`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All text labels can be overridden via the `labels` prop. Pass a `Record<string, string>` with any of these keys:

| Key | Default value |
|-----|---------------|
| `subtotal` | `Subtotal:` |
| `discount` | `Discount:` |
| `shippingCosts` | `Shipping costs:` |
| `totalExclVat` | `Total excl. VAT:` |
| `vat` | `VAT` |
| `totalVat` | `Total VAT:` |
| `total` | `Total:` |
| `checkoutButton` | `Continue to Checkout` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  subtotal: "Subtotal:",
  discount: "Discount:",
  shippingCosts: "Shipping costs:",
  totalExclVat: "Total excl. VAT:",
  vat: "VAT",
  totalVat: "Total VAT:",
  total: "Total:",
  checkoutButton: "Continue to Checkout",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Row visibility

Each summary row is controlled by its corresponding `show*` prop. All default to `true`.

- **Subtotal** -- always rendered when `showSubtotal` is `true`.
- **Discount** -- only rendered when `showDiscount` is `true` AND `cart.total.discount > 0`. The value is displayed with a leading minus sign.
- **Shipping costs** -- only rendered when `showShippingCosts` is `true` AND `cart.postageData.price > 0`.
- **Total excl. VAT** -- rendered when `showTotalExclVat` is `true`. Displayed with a top border to visually separate it from the rows above.
- **VAT breakdown** -- rendered when `showVATs` is `true` AND there are tax levels with both `taxPercentage > 0` and `price > 0`. Each level is shown as a separate row (e.g., "21% VAT: ...").
- **Total VAT** -- rendered when `showTotalVat` is `true` AND the computed total VAT is greater than zero.
- **Total (incl. VAT)** -- always rendered. This row cannot be hidden; it is the primary output of the component.
- **Checkout button** -- rendered when `showCheckoutButton` is `true`. Clicking it calls `onCheckoutButtonClick` with the current cart.

### Price formatting

By default, prices are formatted as `€X.XX` (euro sign followed by the number with two decimal places). Pass a `formatPrice` function to override this for any currency or locale.

### Layout

The component renders as a vertical stack of rows. Each row is a flex container with the label on the left and the formatted price on the right. The total row and the total-excl-VAT row include top borders for visual separation. The checkout button spans the full width below the total.

## SDK Services

CartSummary is a display-only component -- it does not call any SDK services itself. It receives a `Cart` object (from `propeller-sdk-v2`) as a prop and reads the following fields:

### Cart fields used

| Field | Type | Purpose |
|-------|------|---------|
| `cart.total.subTotal` | `number` | Line items subtotal before discounts |
| `cart.total.discount` | `number` | Total discount amount applied to the cart |
| `cart.total.totalGross` | `number` | Cart total excluding VAT |
| `cart.total.totalNet` | `number` | Cart total including VAT (the final price) |
| `cart.postageData.price` | `number` | Shipping / postage costs |
| `cart.taxLevels` | `Array<{ taxPercentage: number; price: number }>` | Individual VAT rates and their amounts |

The total VAT amount is computed as `totalNet - totalGross` (not read from a single field).

---

## DeliveryDate

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/cart-and-checkout/delivery-date

# DeliveryDate

Provides an interface for selecting a preferred delivery date during checkout. Displays a row of quick-select date tiles for upcoming days, plus an optional "Other date..." tile that opens a modal with a native date picker.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic -- show 3 upcoming weekdays with date picker

```tsx


<DeliveryDate
  onDateSelect={(date) => setDeliveryDate(date)}
/>
```

### Show 5 days including weekends, no custom date picker

```tsx
<DeliveryDate
  showUpcomingDays={5}
  skipWeekends={false}
  showDatePicker={false}
  onDateSelect={(date) => setDeliveryDate(date)}
/>
```

### Custom date formatting and labels

```tsx
<DeliveryDate
  onDateSelect={(date) => setDeliveryDate(date)}
  formatDateDisplay={(iso) => {
    const d = new Date(iso);
    return d.toLocaleDateString('nl-NL', { weekday: 'long', day: 'numeric', month: 'long' });
  }}
  labels={{
    pickDate: 'Kies een andere datum...',
    modalTitle: 'Selecteer een leverdatum',
    cancel: 'Annuleren',
  }}
/>
```

### Inside a checkout form

```tsx
const [deliveryDate, setDeliveryDate] = useState('');

<form onSubmit={handleCheckout}>
  <h2>Choose delivery date</h2>
  <DeliveryDate
    showUpcomingDays={4}
    onDateSelect={(date) => setDeliveryDate(date)}
    containerClass="my-4"
  />
  <button type="submit" disabled={!deliveryDate}>Continue</button>
</form>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom delivery date selector, the key requirements are:

1. **Date generation**: Start from tomorrow (`today + 1`) and collect N valid dates, optionally skipping weekend days (Saturday = 6, Sunday = 0).

2. **ISO date format**: The Propeller API expects dates in `YYYY-MM-DDT00:00:00Z` format. Use this format when communicating with the backend.

3. **Display formatting**: Convert ISO strings to human-readable labels. The default uses short English weekday and month names (e.g., `Wed, Mar 12`). Override with a locale-aware formatter for other languages.

4. **Custom date picker**: For dates beyond the quick-select range, use a native `<input type="date">` with `min` set to tomorrow's date in `YYYY-MM-DD` format. Convert the selected value back to the full ISO format before passing it to the callback.

5. **Selection state**: Track which date is selected. Distinguish between quick-select dates and custom-picked dates to apply the correct visual highlight.

6. **Modal pattern**: The built-in date picker uses a modal overlay with backdrop click-to-close. If building your own, ensure the modal is rendered in a portal or at a high z-index to avoid stacking context issues.

### Sending the selected date to the backend

A common integration pattern is to pass the selected ISO date string to a cart update via the Propeller SDK's `CartService`:

```tsx


const cartService = new CartService(graphqlClient);
await cartService.cartUpdate({
  cartId: cart.cartId,
  deliveryDate: selectedDate, // ISO string from onDateSelect
});
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Date Selection

| Prop | Type | Default | Description |
|---|---|---|---|
| `showUpcomingDays` | `number` | `3` | Number of upcoming days to display as quick-select tiles |
| `skipWeekends` | `boolean` | `true` | Whether to skip Saturdays and Sundays when generating upcoming dates |
| `showDatePicker` | `boolean` | `true` | Show an "Other date..." tile that opens a modal with a native `<input type="date">` |

### Callbacks

| Prop | Type | Default | Description |
|---|---|---|---|
| `onDateSelect` | `(date: string) => void` | -- | Called when a date is selected. Receives the date in ISO format: `YYYY-MM-DDT00:00:00Z` |

### Display & Customization

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatDateDisplay` | `(date: string) => string` | -- | Custom function to format dates for display. Receives an ISO string, returns display text. Default format: `Wed, Mar 12` |
| `labels` | `Record<string, string>` | -- | Override default label strings. Supported keys: `pickDate` (default `"Other date..."`), `modalTitle` (default `"Select a delivery date"`), `cancel` (default `"Cancel"`) |
| `containerClass` | `string` | `'delivery-date'` | CSS class applied to the outermost container element |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function deliveryDateSelector(options: DeliveryDateOptions): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `showUpcomingDays` | `number` | `3` | `showUpcomingDays` prop |
| `skipWeekends` | `boolean` | `true` | `skipWeekends` prop |
| `showDatePicker` | `boolean` | `true` | `showDatePicker` prop |
| `onDateSelect` | `(date: string) => void` | (required) | `onDateSelect` prop |
| `formatDateDisplay` | `(date: string) => string` | -- | `formatDateDisplay` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `containerClass` -- CSS class for the outermost container
- `labels` -- UI string overrides for tile text, modal title, and cancel button

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|-----|---------|-------------|
| `pickDate` | `"Other date..."` | Text on the custom date picker tile |
| `modalTitle` | `"Select a delivery date"` | Heading inside the date picker modal |
| `cancel` | `"Cancel"` | Cancel button text in the modal |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  pickDate: "Other date...",
  modalTitle: "Select a delivery date",
  cancel: "Cancel",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- Generates upcoming dates starting from **tomorrow** (never today).
- Weekends (Saturday and Sunday) are **skipped by default**. Set `skipWeekends={false}` to include them.
- The quick-select tiles are rendered in a responsive grid: 1 column on mobile, 2 on small screens, up to 4 on medium+ screens.
- Clicking a tile selects that date, applies a visual highlight (`border-secondary` + light background), and fires `onDateSelect`.
- The "Other date..." tile opens a modal with a native HTML date input. The minimum selectable date is tomorrow.
- When a custom date is picked, the modal closes automatically and `onDateSelect` fires with the ISO-formatted date.
- If a custom date was previously selected, the "Other date..." tile shows the formatted date instead of the placeholder text.
- Only one date can be selected at a time. Selecting a new date (quick-select or custom) replaces the previous selection.
- The modal closes when clicking the backdrop area outside the dialog, or by pressing the close (X) button or Cancel button.

## SDK Services

This component does **not** call any SDK services directly. It is a purely presentational date-selection UI. The parent component is responsible for sending the selected date to the backend, typically via the cart or order mutation.

A common integration pattern is to pass the selected ISO date string to a cart update mutation:

```graphql
mutation CartUpdate($input: CartUpdateInput!) {
  cartUpdate(input: $input) {
    cart {
      cartId
      deliveryDate
    }
  }
}
```

With variables:

```json
{
  "input": {
    "cartId": "abc-123",
    "deliveryDate": "2026-03-27T00:00:00Z"
  }
}
```

In practice, this is handled through the Propeller SDK's `CartService`:

```tsx


const cartService = new CartService(graphqlClient);
await cartService.cartUpdate({
  cartId: cart.cartId,
  deliveryDate: selectedDate, // ISO string from onDateSelect
});
```

---

## ClusterCard

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/clusters/cluster-card

# ClusterCard

A card component that renders a Propeller Commerce cluster: default product image with optional badge overlays, cluster details (name, SKU, manufacturer, short description, price, stock), a favourite toggle, and a "View cluster" navigation button. Supports both grid and row layouts.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic grid card

```tsx



<ClusterCard
  cluster={cluster}
  configuration={config}
  language="NL"
/>
```

### SPA navigation with Next.js router

```tsx


const router = useRouter();

<ClusterCard
  cluster={cluster}
  configuration={config}
  onClusterClick={(c) => router.push(config.urls.getClusterUrl(c, 'NL'))}
/>
```

### With image badges and text attribute labels

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  imageLabels={['new', 'sale']}
  textLabels={['brand', 'color']}
/>
```

Each string in `imageLabels` / `textLabels` is matched against `defaultProduct.attributes.items[].attributeDescription.name`. Attributes with no matching value are silently omitted.

### With favourite toggle

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  enableAddFavorite={true}
  onToggleFavorite={(cluster, isFavorite) => {
    isFavorite
      ? wishlistService.add(cluster.clusterId)
      : wishlistService.remove(cluster.clusterId);
  }}
/>
```

### All display options enabled

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  showName={true}
  showImage={true}
  showSku={true}
  showManufacturer={true}
  showShortDescription={true}
  showStock={true}
  showAvailability={true}
  language="NL"
/>
```

### Row layout (single-column list)

When `columns` is set to `1`, the card renders as a compact horizontal row instead of a vertical card.

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  columns={1}
/>
```

### Localised labels (Dutch)

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  labels={{
    addToFavorites: 'Toevoegen aan favorieten',
    removeFromFavorites: 'Verwijderen uit favorieten',
    viewCluster: 'Bekijk cluster',
    inStock: 'Op voorraad',
    lowStock: 'Weinig voorraad',
    outOfStock: 'Niet op voorraad',
  }}
  stockLabels={{
    inStock: 'Op voorraad',
    outOfStock: 'Niet op voorraad',
    lowStock: 'Weinig voorraad',
    pieces: 'stuks',
  }}
/>
```

### Price excluding VAT

```tsx
<ClusterCard
  cluster={cluster}
  configuration={config}
  includeTax={false}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

Standalone example showing how to render a minimal cluster card without using this component:

```tsx


interface SimpleClusterCardProps {
  cluster: Cluster;
  language?: string;
  onClick?: (cluster: Cluster) => void;
}

function SimpleClusterCard({ cluster, language = 'NL', onClick }: SimpleClusterCardProps) {
  const name =
    cluster.names?.find((n) => n.language === language)?.value ||
    cluster.defaultProduct?.names?.find((n) => n.language === language)?.value ||
    cluster.names?.[0]?.value ||
    'Unnamed cluster';

  const imageUrl =
    cluster.defaultProduct?.media?.images?.items?.[0]?.imageVariants?.[0]?.url;

  const price = cluster.defaultProduct?.price?.net;

  const sku = cluster.sku || cluster.defaultProduct?.sku || '';

  const stockQty = cluster.defaultProduct?.inventory?.totalQuantity;

  const handleClick = (e: React.MouseEvent) => {
    if (onClick) {
      e.preventDefault();
      onClick(cluster);
    }
  };

  return (
    <div className="rounded-lg border border-gray-200 bg-white p-4">
      {imageUrl ? (
        <img
          src={imageUrl}
          alt={name}
          className="mb-3 h-48 w-full object-contain"
        />
      ) : (
        <div className="mb-3 flex h-48 items-center justify-center bg-gray-50 text-gray-300">
          No image
        </div>
      )}

      {sku && (
        <p className="font-mono text-xs text-gray-400">{sku}</p>
      )}

      <a
        href={`/cluster/${cluster.clusterId}`}
        onClick={handleClick}
        className="block text-sm font-medium text-gray-900 hover:text-primary"
      >
        {name}
      </a>

      {stockQty !== undefined && stockQty !== null && (
        <p className={`text-xs ${stockQty > 0 ? 'text-green-600' : 'text-red-600'}`}>
          {stockQty > 0 ? `In stock (${stockQty})` : 'Out of stock'}
        </p>
      )}

      {price !== undefined && price !== null && (
        <p className="mt-2 text-lg font-bold text-gray-900">
          &euro;{Number(price).toFixed(2)}
        </p>
      )}

      <a
        href={`/cluster/${cluster.clusterId}`}
        onClick={handleClick}
        className="mt-3 block w-full rounded bg-primary px-4 py-2 text-center text-sm font-medium text-white"
      >
        View cluster
      </a>
    </div>
  );
}

export default SimpleClusterCard;
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Description |
|---|---|---|---|
| `cluster` | `Cluster` | Yes | The Propeller cluster object to display |
| `configuration` | `any` | Yes | App configuration object (from `@/data/config`). Must expose `urls.getClusterUrl()` |
| `language` | `string` | No | Language code for resolving localised names and slugs. Defaults to `'NL'` |

### Display toggles

| Prop | Type | Default | Description |
|---|---|---|---|
| `showName` | `boolean` | `true` | Renders the cluster name as a clickable link |
| `showImage` | `boolean` | `true` | Renders the default product image area |
| `showSku` | `boolean` | `true` | Renders SKU; uses `cluster.sku`, falls back to `defaultProduct.sku` |
| `showShortDescription` | `boolean` | `false` | Renders the first localised short description |
| `showManufacturer` | `boolean` | `false` | Renders `defaultProduct.manufacturer` |
| `showStock` | `boolean` | `true` | Renders a stock badge via the embedded `ItemStock` component |
| `showAvailability` | `boolean` | `true` | Shows the availability indicator inside `ItemStock`. Only relevant when `showStock` is true |

### Layout

| Prop | Type | Default | Description |
|---|---|---|---|
| `columns` | `number` | `undefined` | When set to `1`, renders the card as a compact horizontal row instead of a vertical card |
| `className` | `string` | `undefined` | Extra CSS class applied to the root element |

### Attribute labels

| Prop | Type | Description |
|---|---|---|
| `imageLabels` | `string[]` | Attribute names whose values are shown as badge overlays on the image |
| `textLabels` | `string[]` | Attribute names whose values are shown as extra text rows below the name |

Attribute lookup is performed against `defaultProduct.attributes.items[n].attributeDescription.name`. The resolved `value.value` string is rendered. Entries with no match are dropped.

### Favourites

| Prop | Type | Default | Description |
|---|---|---|---|
| `enableAddFavorite` | `boolean` | `false` | Renders a heart-icon toggle button on the image |
| `onToggleFavorite` | `(cluster: Cluster, isFavorite: boolean) => void` | -- | Called on every favourite state change. `isFavorite = true` means just added |

### Navigation

| Prop | Type | Description |
|---|---|---|
| `onClusterClick` | `(cluster: Cluster) => void` | Called when the name, image, or button is clicked. When provided, default `<a>` navigation is suppressed so you can use framework-specific routing |

### Pricing

| Prop | Type | Default | Description |
|---|---|---|---|
| `includeTax` | `boolean` | `true` | When `true`, shows `price.net` (incl. VAT). When `false`, shows `price.gross` (excl. VAT). If omitted, follows the global price toggle from `localStorage` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderClusterCard(
  cluster: Cluster,
  options?: {
    language?: string;
    includeTax?: boolean;
    imageLabels?: string[];
    textLabels?: string[];
  }
): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cluster` | `Cluster` | — | `cluster` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `includeTax` | `boolean` | `true` | `includeTax` prop |
| `imageLabels` | `string[]` | `undefined` | `imageLabels` prop |
| `textLabels` | `string[]` | `undefined` | `textLabels` prop |

### Callbacks

| Callback | When it fires | What to implement |
|---|---|---|
| `onClusterClick` | Name, image, or button is clicked | Navigate to cluster detail page using `configuration.urls.getClusterUrl()` or your own routing |
| `onToggleFavorite` | Heart icon is toggled | Add or remove cluster from a wishlist via your preferred service |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `className`
- `columns`
- `showName`, `showImage`, `showSku`, `showShortDescription`, `showManufacturer`, `showStock`, `showAvailability`
- `enableAddFavorite`
- `labels`, `stockLabels`

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

Pass UI string overrides via the `labels` prop:

| Key | Default value | Used for |
|---|---|---|
| `addToFavorites` | `'Add to favourites'` | `aria-label` on the heart button (not yet favourited) |
| `removeFromFavorites` | `'Remove from favourites'` | `aria-label` on the heart button (already favourited) |
| `viewCluster` | `'View cluster'` | Text of the navigation button |
| `inStock` | `'In stock'` | Stock badge when `totalQuantity > 5` |
| `lowStock` | `'Low stock'` | Stock badge when `1 <= totalQuantity <= 5` |
| `outOfStock` | `'Out of stock'` | Stock badge when `totalQuantity === 0` |

Pass stock-specific label overrides via the `stockLabels` prop (forwarded to `ItemStock`):

| Key | Default value |
|---|---|
| `inStock` | `'In stock'` |
| `outOfStock` | `'Out of stock'` |
| `lowStock` | `'Low stock'` |
| `available` | `'Available'` |
| `notAvailable` | `'Not available'` |
| `pieces` | `'pieces'` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  addToFavorites: 'Add to favourites',
  removeFromFavorites: 'Remove from favourites',
  viewCluster: 'View cluster',
  inStock: 'In stock',
  lowStock: 'Low stock',
  outOfStock: 'Out of stock',
};

const stockLabels = {
  inStock: 'In stock',
  outOfStock: 'Out of stock',
  lowStock: 'Low stock',
  available: 'Available',
  notAvailable: 'Not available',
  pieces: 'pieces',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Price toggle

The component supports the global price toggle pattern used across the application:

- When `includeTax` is explicitly passed as a prop, it takes precedence.
- When `includeTax` is omitted, the component reads from `localStorage` key `price_include_tax` and listens for the `priceToggleChanged` custom event to stay in sync with the `PriceToggle` component.
- `price.net` = price including VAT, `price.gross` = price excluding VAT. The price is formatted as `EUR X.XX`.

### Image handling

- When the default product has media, the first image variant URL is rendered inside an `object-contain` container.
- When no image URL is available, a grey SVG placeholder icon is rendered instead.
- In grid view, the image area uses `aspect-[4/3]` on small screens and `aspect-square` on larger screens.
- In row view, the image is a fixed 80x80px thumbnail.

### Cluster vs Product differences

A **cluster** groups multiple product variants (e.g., sizes, colors) under a single entity. The ClusterCard always shows data from the cluster's `defaultProduct` for fields like price, stock, images, and manufacturer. The cluster itself provides the name, SKU, short description, and URL slug, falling back to the default product's values when the cluster-level data is empty.

Unlike `ProductCard`, which links to a single product detail page, `ClusterCard` links to a cluster page where users can select among variants.

### Grid vs Row layout

- **Grid layout** (default): Vertical card with stacked image, details, and action button. Best for multi-column grids.
- **Row layout** (`columns={1}`): Compact horizontal layout with a small thumbnail, inline details, and right-aligned price and action button. Suitable for list views.

### Stock badge

The stock badge reads `defaultProduct.inventory.totalQuantity` and renders via the embedded `ItemStock` component:

| Condition | Color | Label key |
|---|---|---|
| `totalQuantity > 5` | Green | `inStock` |
| `1 <= totalQuantity <= 5` | Amber | `lowStock` |
| `totalQuantity === 0` | Red | `outOfStock` |
| Inventory not present | Hidden | -- |

### Favourite toggle

The component maintains an internal `isFavorite` boolean starting at `false`. Clicking the heart button toggles it and fires `onToggleFavorite(cluster, newState)`. There is no prop to set the initial favourite state -- manage pre-seeded state externally.

### Navigation

The cluster name, image, and "View cluster" button all render as `<a>` tags with the URL generated by `configuration.urls.getClusterUrl()`. If `onClusterClick` is provided, `e.preventDefault()` is called and routing is delegated to the callback, enabling SPA navigation without full page reloads.

## GraphQL Query Examples

### Fetching clusters for a category listing

```graphql
query Clusters($categoryId: Int!, $language: String) {
  clusters(
    input: {
      categoryId: $categoryId
      language: $language
      offset: 0
      limit: 20
    }
  ) {
    items {
      clusterId
      sku
      names { language value }
      slugs { language value }
      shortDescriptions { language value }
      defaultProduct {
        productId
        sku
        names { language value }
        slugs { language value }
        shortDescriptions { language value }
        manufacturer
        price { net gross }
        inventory { totalQuantity }
        media {
          images {
            items {
              imageVariants {
                url
              }
            }
          }
        }
        attributes {
          items {
            attributeDescription { name }
            value { value }
          }
        }
      }
    }
    itemsFound
  }
}
```

### Fetching a single cluster by ID

```graphql
query Cluster($clusterId: Int!, $language: String) {
  cluster(id: $clusterId, language: $language) {
    clusterId
    sku
    names { language value }
    slugs { language value }
    defaultProduct {
      productId
      price { net gross }
      inventory { totalQuantity }
      media {
        images {
          items {
            imageVariants { url }
          }
        }
      }
    }
  }
}
```

## SDK Services and Types

The component uses the following types from `propeller-sdk-v2`:

| Type | Usage |
|---|---|
| `Cluster` | The main cluster data object passed via `cluster` prop |
| `AttributeResult` | Used to resolve `imageLabels` and `textLabels` from `defaultProduct.attributes.items[]` |

### Key data paths on the `Cluster` type

| Data | Path | Notes |
|---|---|---|
| Name | `cluster.names[]` | Array of `{ language, value }`. Falls back to `defaultProduct.names[]` |
| SKU | `cluster.sku` | Falls back to `defaultProduct.sku` |
| Image | `defaultProduct.media.images.items[0].imageVariants[0].url` | First image variant of the default product |
| Price | `defaultProduct.price.net` / `defaultProduct.price.gross` | `net` = incl. VAT, `gross` = excl. VAT |
| URL slug | `cluster.slugs[]` | Falls back to `defaultProduct.slugs[]`. Resolved via `configuration.urls.getClusterUrl()` |
| Short description | `cluster.shortDescriptions[]` | Falls back to `defaultProduct.shortDescriptions[]` |
| Manufacturer | `defaultProduct.manufacturer` | Plain string |
| Stock | `defaultProduct.inventory.totalQuantity` | Integer; `undefined` means inventory data not loaded |
| Attributes | `defaultProduct.attributes.items[]` | Each item has `attributeDescription.name` and `value.value` |

---

## ClusterConfigurator

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/clusters/cluster-configurator

# ClusterConfigurator

A variant selector for product clusters. Renders attribute-based configuration controls (dropdowns, radio pills, color swatches, image thumbnails) and resolves the matching product as the user makes selections. Supports drilldown filtering where each selection narrows the options available in subsequent attributes.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage on a cluster detail page

```tsx


function ClusterDetailPage({ cluster }) {
  const [selectedProduct, setSelectedProduct] = useState(null);

  return (
    <ClusterConfigurator
      clusterId={cluster.clusterId}
      products={cluster.products}
      config={cluster.config}
      onConfigurationChange={(product) => setSelectedProduct(product)}
    />
  );
}
```

### Pre-selecting a default product

When landing on a cluster page via a direct product link, pass the product as `defaultProduct` to pre-populate all selectors on mount:

```tsx
<ClusterConfigurator
  clusterId={cluster.clusterId}
  products={cluster.products}
  config={cluster.config}
  defaultProduct={activeProduct}
  onConfigurationChange={(product) => setSelectedProduct(product)}
/>
```

### With custom labels

```tsx
<ClusterConfigurator
  clusterId={cluster.clusterId}
  products={cluster.products}
  config={cluster.config}
  labels={{ selectOption: '-- Choose an option --' }}
  onConfigurationChange={(product) => setSelectedProduct(product)}
/>
```

### Integrating with AddToCart

Pair the configurator with `AddToCart` so the resolved product can be added to the cart:

```tsx
function ClusterPage({ cluster }) {
  const [product, setProduct] = useState(cluster.products[0]);

  return (
    <div>
      <ClusterConfigurator
        clusterId={cluster.clusterId}
        products={cluster.products}
        config={cluster.config}
        defaultProduct={product}
        onConfigurationChange={setProduct}
      />
      {product && (
        <AddToCart
          product={product}
          graphqlClient={graphqlClient}
          cartId={cart?.cartId}
        />
      )}
    </div>
  );
}
```

### With custom styling

```tsx
<ClusterConfigurator
  clusterId={cluster.clusterId}
  products={cluster.products}
  config={cluster.config}
  className="max-w-md mx-auto"
  onConfigurationChange={(product) => setSelectedProduct(product)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom cluster configurator, you need three things from the Propeller API:

1. **Cluster products** with their attributes
2. **Cluster config settings** defining which attributes to use and their display order
3. **A matching algorithm** to resolve selections to a product

### Data flow and core logic

The configurator needs three inputs: `products` (all cluster products with attributes), `config` (the `ClusterConfig` with settings), and a `selections` map (attribute name to selected value).

```ts
// Sort settings by priority (ascending)
const settings = [...config.settings].sort(
  (a, b) => parseInt(a.priority) - parseInt(b.priority)
);
```

### Get available attribute values (with drilldown filtering)

```ts
function getValues(
  attrName: string,
  products: Product[],
  priorSelections: Record<string, string> | null
): string[] {
  // Filter products by all prior attribute selections
  const filtered = priorSelections
    ? products.filter((p) => matchesSelections(p, priorSelections))
    : products;

  const values = new Set<string>();
  for (const product of filtered) {
    for (const attr of product.attributes?.items || []) {
      if (attr.attributeDescription?.name === attrName) {
        // Extract value based on type -- see Attribute Value Extraction above
        values.add(extractValue(attr));
      }
    }
  }
  return [...values];
}
```

### Check if a product matches all selections

```ts
function matchesSelections(product: Product, sels: Record<string, string>): boolean {
  return Object.entries(sels).every(([name, value]) =>
    product.attributes?.items?.some(
      (attr) =>
        attr.attributeDescription?.name === name &&
        extractValue(attr) === value
    )
  );
}
```

### Handle a selection change

```ts
function handleSelect(
  selections: Record<string, string>,
  settings: ClusterConfigSetting[],
  products: Product[],
  name: string,
  value: string,
  index: number
): { newSelections: Record<string, string>; matchedProduct: Product | undefined } {
  const next = { ...selections, [name]: value };
  // Clear subsequent selections
  for (let i = index + 1; i < settings.length; i++) {
    delete next[settings[i].name];
  }

  // Check if all attributes are selected and resolve the matching product
  let matchedProduct: Product | undefined;
  if (settings.every((s) => next[s.name])) {
    matchedProduct = products.find((p) => matchesSelections(p, next));
  }
  return { newSelections: next, matchedProduct };
}
```

For each setting, build `priorSelections` from all settings before the current index and call `getValues()` to determine the available options. Disable a selector when any preceding attribute has not been selected. Render selectors according to `setting.displayType` (DROPDOWN, RADIO, COLOR, IMAGE, or default pills).

### Pre-selecting a default product

```ts
// Read attribute values from the default product and populate selections
function initFromDefaultProduct(
  defaultProduct: Product,
  settings: ClusterConfigSetting[],
  products: Product[]
): { selections: Record<string, string>; matchedProduct: Product | undefined } {
  const selections: Record<string, string> = {};
  for (const setting of settings) {
    const attr = defaultProduct.attributes?.items?.find(
      a => a.attributeDescription?.name === setting.name
    );
    if (attr) {
      selections[setting.name] = extractValue(attr);
    }
  }
  let matchedProduct: Product | undefined;
  if (settings.every(s => selections[s.name])) {
    matchedProduct = products.find(p => matchesSelections(p, selections));
  }
  return { selections, matchedProduct };
}
```

### Key considerations for custom implementations

- **Priority ordering matters** — Settings must be sorted by priority to ensure drilldown filtering works correctly. Higher-priority attributes (lower number) filter lower-priority ones.
- **Attribute format complexity** — The Propeller SDK uses multiple value formats across versions. Always handle at least `COLOR`, `TEXT`, `DECIMAL`, `INT`, and `ENUM` types plus fallback extraction.
- **Localised attribute names** — Config setting names may use internal names or localised labels. Check both `attributeDescription.name` and `attributeDescription.descriptions[].value` when matching.
- **Auto-selection UX** — Pre-selecting subsequent attributes after each change provides a smoother experience since most users only need to change one attribute at a time.
- **Immediate resolution** — Fire `onConfigurationChange` as soon as all attributes have values, not just when the user explicitly confirms. Combined with auto-selection, this means the parent component always has a resolved product.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| `clusterId` | `number` | The cluster ID this configurator belongs to. Used to namespace radio button groups. |
| `products` | `Product[]` | All products belonging to the cluster. The component scans their attributes to derive available values and to match the configured product. |
| `config` | `ClusterConfig` | The cluster configuration object (`cluster.config`). Provides the ordered list of attribute settings that define which selectors to render. |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onConfigurationChange` | `(product: Product) => void` | Fires when the user's selections uniquely identify a cluster product. Also fires on mount if `defaultProduct` is provided and all settings can be resolved. |

### Optional

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `defaultProduct` | `Product` | — | A product to pre-populate all attribute selections on mount. The component reads its attributes to set initial values. |
| `labels` | `Record<string, string>` | `{}` | Override UI strings. Currently supported keys: `selectOption` (dropdown placeholder, defaults to `"-- Select --"`). |
| `className` | `string` | `''` | Extra CSS class applied to the root `<div>`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


function buildConfigurator(
  clusterId: number,
  products: Product[],
  config: ClusterConfig,
  defaultProduct?: Product
): {
  selections: Record<string, string>;
  matchedProduct: Product | undefined;
}
```

### Options table

| Field | Type | Default | Maps to |
|------|------|---------|---------|
| `clusterId` | `number` | -- | Namespace for radio button groups |
| `products` | `Product[]` | -- | All cluster products scanned for attribute values and product matching |
| `config` | `ClusterConfig` | -- | `config.settings` defines which attributes to render as selectors, sorted by `priority` |
| `defaultProduct` | `Product` | `undefined` | Pre-populates selections by reading its attributes on init |

### Callbacks table

| Callback | When it fires | What to implement |
|------|------|---------|
| `onConfigurationChange` | User's selections uniquely identify a cluster product (also on mount if `defaultProduct` resolves) | Update parent state with the resolved `Product` (e.g., update price display, enable add-to-cart) |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `labels` -- UI string overrides (e.g., `selectOption` for dropdown placeholder)
- `className` -- CSS class for styling

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|------|------|-------------|
| `selectOption` | `"-- Select --"` | Dropdown placeholder text |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  selectOption: '-- Select --',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Display Types

Each `ClusterConfigSetting` has a `displayType` that determines how the selector is rendered:

| Display Type | Rendering | Interaction |
|-------------|-----------|-------------|
| `DROPDOWN` | Standard `<select>` element with a placeholder option | Select from dropdown list |
| `RADIO` | Horizontal row of pill-shaped buttons | Click to select; selected pill gets accent border and background |
| `COLOR` | Circular color swatches using the attribute value as `backgroundColor` | Click to select; selected swatch gets ring highlight and slight scale-up |
| `IMAGE` | 64x64px thumbnail grid using the attribute value as image `src` | Click to select; selected thumbnail gets border highlight and a checkmark overlay |
| Any other value | Rectangular pill buttons (same as RADIO but without hidden radio inputs) | Click to select |

### Drilldown Filtering

Settings are sorted by `priority` (ascending) and rendered in that order. The component implements cascading drilldown logic:

1. **First attribute** — All unique values across all cluster products are shown.
2. **Subsequent attributes** — Only values that exist on products matching all prior selections are shown. This narrows options progressively.
3. **Disabled state** — An attribute selector is disabled when either no values are available or any preceding attribute has not been selected yet.

### Selection Cascading

When the user changes a selection:

1. The selected value is stored for that attribute.
2. All subsequent attribute selections are cleared.
3. The component automatically pre-selects the first available value for each subsequent attribute (cascading forward).
4. If all settings end up with a value (which is typical after any selection due to auto-fill), the matching product is resolved and `onConfigurationChange` fires.

This means that in most cases, a single user interaction resolves to a complete configuration immediately.

### Default Product Initialization

When `defaultProduct` is provided:

1. On mount, the component reads each setting's attribute value from the default product.
2. All matching selections are populated.
3. If all settings can be resolved, `onConfigurationChange` fires immediately with the matched product.

### Product Matching

The `findMatchingProduct` algorithm iterates over all cluster products and returns the first one whose attributes match every key/value pair in the current selections. Matching is done by comparing attribute values extracted from `AttributeResult` objects.

### Attribute Value Extraction

The component handles multiple Propeller SDK attribute value formats:

- **Current SDK format** — `AttributeType.COLOR`, `TEXT`, `DECIMAL`, `INT`, `ENUM` (accessed via `value.type` and `value.value`)
- **Legacy SDK format** — `colorValue`, `textValues`, `textValue`, `numericValue`, `booleanValue` (accessed directly on the value object)
- **Fallback** — Plain string values or generic object with a `values` array

### Attribute Name Resolution

Attribute names are matched flexibly. The component checks:

1. The first localised description value (`attributeDescription.descriptions[0].value`)
2. The internal SDK name (`attributeDescription.name`)
3. All localised descriptions for any match

This ensures the component works regardless of whether the `ClusterConfigSetting.name` uses the internal name or a localised label.

---

## GraphQL Query Examples

### Fetching a cluster with configuration and product attributes

```graphql
query GetCluster($clusterId: Int!, $language: String) {
  cluster(id: $clusterId, language: $language) {
    clusterId
    name {
      value
      language
    }
    config {
      settings {
        id
        name
        priority
        displayType
      }
    }
    products {
      items {
        productId
        sku
        name {
          value
          language
        }
        attributes {
          items {
            attributeDescription {
              name
              descriptions {
                value
                language
              }
            }
            value {
              type
              value
            }
          }
        }
        price {
          net
          gross
        }
        media {
          images {
            url
          }
        }
      }
    }
  }
}
```

### Fetching only the configuration settings (lightweight)

```graphql
query GetClusterConfig($clusterId: Int!) {
  cluster(id: $clusterId) {
    config {
      settings {
        id
        name
        priority
        displayType
      }
    }
  }
}
```

---

## SDK Services

This component does **not** call any SDK services directly. It is a pure presentation and logic component that receives all data through props.

The parent page is responsible for fetching the cluster and its products. Typically this involves:

- **`ClusterService.getCluster()`** — Fetches the cluster object including `config` (the `ClusterConfig` with settings) and `products` (all variant products with their attributes).

### Required data shape

The component expects products to carry their attributes in `product.attributes.items` as an array of `AttributeResult` objects. Each `AttributeResult` must include:

- `attributeDescription.name` — the internal attribute name (must match `ClusterConfigSetting.name`)
- `attributeDescription.descriptions[].value` — localised display names
- `value` — the attribute value in one of the supported SDK formats (see Attribute Value Extraction below)

The `ClusterConfig` must include:

- `settings[]` — array of `ClusterConfigSetting` objects, each with `id`, `name`, `priority`, and `displayType`

---

## ClusterInfo

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/clusters/cluster-info

# ClusterInfo

Displays the headline information for a product cluster (configurable product group): the cluster name and SKU. Supports two data modes -- pass a pre-fetched `Cluster` object or let the component fetch its own data via `clusterId` + `graphqlClient`.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Pre-fetched cluster (simplest)

```tsx
<ClusterInfo
  cluster={cluster}
  user={user}
  language="EN"
/>
```

### Self-fetching by cluster ID

```tsx
<ClusterInfo
  clusterId={4821}
  graphqlClient={graphqlClient}
  user={user}
  language="EN"
  configuration={config}
  onClusterLoaded={(cluster) => {
    setCluster(cluster);
  }}
/>
```

### Hiding SKU, custom class

```tsx
<ClusterInfo
  cluster={cluster}
  user={user}
  showSku={false}
  className="mb-8"
/>
```

### With image and attribute filters (self-fetching)

```tsx


<ClusterInfo
  clusterId={4821}
  graphqlClient={graphqlClient}
  user={user}
  language="EN"
  imageSearchFilters={{ page: 1, offset: 20 }}
  imageVariantFilters={imageVariantFiltersMedium}
  configuration={config}
  imageLabels={['new', 'sale']}
  textLabels={['brand', 'color']}
  onClusterLoaded={(cluster) => {
    // Hydrate sibling components: configurator, price panel, gallery
    setCluster(cluster);
  }}
/>
```

### On a cluster detail page with sibling components

```tsx
function ClusterDetailPage({ clusterId }: { clusterId: number }) {
  const [cluster, setCluster] = useState<Cluster | null>(null);
  const { authState } = useAuth();

  return (
    <div>
      <ClusterInfo
        clusterId={clusterId}
        graphqlClient={graphqlClient}
        user={authState.user}
        language="EN"
        configuration={config}
        onClusterLoaded={setCluster}
      />

      {cluster && <ClusterGallery cluster={cluster} />}
      {cluster && <ClusterConfigurator cluster={cluster} />}
    </div>
  );
}
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom cluster info component, you need:

### Fetch cluster config to discover configurable attributes

```ts


const clusterService = new ClusterService(graphqlClient);
const config = await clusterService.getClusterConfig(clusterId);
const attributeNames = config.config?.settings?.map(s => s.name) || [];
```

### Fetch the full cluster with attribute filters

```ts
const cluster = await clusterService.getCluster({
  clusterId,
  language: 'EN',
  imageSearchFilters: { page: 1, offset: 20 },
  imageVariantFilters: { transformations: [] },
  priceCalculateProductInput: { taxZone: 'NL' },
  attributeResultSearchInput: {
    attributeDescription: { names: attributeNames },
  },
});
```

### Resolve localized names

Cluster names are stored as `LocalizedString[]`:

```ts
function getClusterName(cluster: Cluster, language: string): string {
  const match = cluster.names?.find(n => n.language === language);
  return match?.value || cluster.names?.[0]?.value || '';
}
```

### Access basic fields

```ts
const sku = cluster.sku;
const name = getClusterName(cluster, 'EN');
```

### Pre-fetched cluster mode

```ts
// When you already have a cluster object, skip fetching entirely:
const name = getClusterName(cluster, 'EN');
const sku = cluster.sku;
// Pass cluster to sibling components via the onClusterLoaded pattern,
// so the fetch only happens once and the gallery, configurator,
// and price panel all receive the same data.
```

### Self-fetching with image and attribute filters

```ts
const clusterService = new ClusterService(graphqlClient);

// Step 1: Get config for attribute names
const config = await clusterService.getClusterConfig(clusterId);
const attributeNames = config.config?.settings?.map(s => s.name) || [];

// Step 2: Fetch full cluster with filters
const cluster = await clusterService.getCluster({
  clusterId,
  language: 'EN',
  imageSearchFilters: { page: 1, offset: 20 },
  imageVariantFilters: { transformations: [{ name: 'medium', width: 400, height: 400 }] },
  priceCalculateProductInput: { taxZone: 'NL', companyId: 100, contactId: 200 },
  attributeResultSearchInput: {
    attributeDescription: { names: attributeNames },
  },
});

// Step 3: Render name and SKU, pass cluster to siblings
const name = getClusterName(cluster, 'EN');
const sku = cluster.sku;
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data Source

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `user` | `Contact \| Customer \| null` | **required** | The authenticated user. Used to build price calculation input (company, contact, or customer ID). |
| `cluster` | `Cluster` | `undefined` | Pre-fetched cluster object. When provided, the component skips internal fetching entirely. |
| `clusterId` | `number` | `undefined` | Cluster ID to fetch when no `cluster` prop is provided. Requires `graphqlClient`. |
| `graphqlClient` | `GraphQLClient` | `undefined` | Initialized Propeller SDK GraphQL client. Required when using `clusterId`. |
| `onClusterLoaded` | `(cluster: Cluster) => void` | `undefined` | Callback fired once cluster data is available, whether from the prop or after a fetch. Use this to hydrate sibling components (gallery, configurator, price panel). |

### Display Toggles

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showTitle` | `boolean` | `true` | Show the cluster name as an `<h1>` heading. |
| `showSku` | `boolean` | `true` | Show the cluster SKU code. |

### Locale and Styling

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `language` | `string` | `'NL'` | Language code for resolving localized cluster names. |
| `className` | `string` | `''` | Extra CSS class applied to the root `<div>`. |
| `taxZone` | `string` | `'NL'` | Tax zone passed to the price calculation input when self-fetching. |

### Image and Attribute Filters

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `imageSearchFilters` | `object` | Falls back to `configuration.imageSearchFiltersGrid` | Controls how many image items are returned. Example: `{ page: 1, offset: 20 }`. |
| `imageVariantFilters` | `object` | Falls back to `configuration.imageVariantFiltersMedium` | Controls image size/format variants. Must include a `transformations` array (never an empty `{}`). |
| `configuration` | `object` | `undefined` | App config object providing `imageSearchFiltersGrid` and `imageVariantFiltersMedium` as fallbacks. |
| `imageLabels` | `string[]` | `undefined` | Attribute codes to display as badge overlays on product images. Resolved against `product.attributes.items[].attributeDescription.code`. Unmatched codes are silently skipped. |
| `textLabels` | `string[]` | `undefined` | Attribute codes to display as extra text rows below the product name. Resolved the same way as `imageLabels`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


const clusterService = new ClusterService(graphqlClient);

// Step 1: Get cluster config
async function getClusterConfig(clusterId: number): Promise<{ config: ClusterConfig }>

// Step 2: Get full cluster
async function getCluster(variables: {
  clusterId: number;
  language?: string;
  imageSearchFilters?: object;
  imageVariantFilters?: object;
  priceCalculateProductInput?: object;
  attributeResultSearchInput?: object;
}): Promise<Cluster>
```

### Options table

| Field | Type | Default | Maps to |
|------|------|---------|---------|
| `clusterId` | `number` | -- | `clusterId` parameter in `getClusterConfig` and `getCluster` |
| `language` | `string` | `'NL'` | `language` parameter in `getCluster` |
| `taxZone` | `string` | `'NL'` | `priceCalculateProductInput.taxZone` in `getCluster` |
| `user` | `Contact \| Customer \| null` | -- | Used to build `priceCalculateProductInput` (companyId/contactId or customerId) |
| `imageSearchFilters` | `object` | From `configuration.imageSearchFiltersGrid` | `imageSearchFilters` parameter in `getCluster` |
| `imageVariantFilters` | `object` | From `configuration.imageVariantFiltersMedium` | `imageVariantFilters` parameter in `getCluster` |
| `imageLabels` | `string[]` | `undefined` | Attribute codes for badge overlays on product images |
| `textLabels` | `string[]` | `undefined` | Attribute codes for extra text rows below product name |

### Callbacks table

| Callback | When it fires | What to implement |
|------|------|---------|
| `onClusterLoaded` | Cluster data is available (from prop or after fetch) | Pass the cluster to sibling components (gallery, configurator, price panel) |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showTitle` -- show/hide cluster name heading
- `showSku` -- show/hide cluster SKU
- `className` -- CSS class for styling
- `configuration` -- app config for image filter fallbacks

</TabItem>
</Tabs>

---

## Behavior

- **Two data modes**: When a `cluster` prop is provided, the component renders immediately and fires `onClusterLoaded` without making any network request. When only `clusterId` is provided, the component fetches data internally using `ClusterService`.

- **Two-step fetch**: Self-fetching mode first calls `getClusterConfig()` to discover configurable attribute names, then calls `getCluster()` with those names as an attribute filter. This ensures the response includes only the attributes needed for the configurator.

- **Loading skeleton**: While fetching, the component renders a pulsing placeholder (two gray bars mimicking SKU and title lines). The skeleton is hidden as soon as data arrives or when a `cluster` prop is present.

- **Language resolution**: The cluster name is resolved by matching `language` against the `names[]` array. If no match is found for the requested language, the first available name is used as a fallback. Defaults to `'NL'`.

- **Re-fetch triggers**: The component re-fetches only when `clusterId` changes. Language changes do **not** trigger a re-fetch — the existing cluster data is re-rendered using the new language for name resolution. When a `cluster` prop is provided, the component skips fetching entirely (early exit) and fires `onClusterLoaded` synchronously.

- **User-specific pricing**: The `priceCalculateProductInput` is built from the `user` prop, differentiating between B2B Contact users (company + contact IDs) and B2C Customer users (customer ID). This ensures the fetched cluster data includes the correct pricing tier.

- **Error handling**: If the fetch fails, the loading state is cleared silently. No error UI is rendered; the component simply stays empty. The `onClusterLoaded` callback is **not** called on error — only on successful data retrieval.

- **Configuration required for self-fetching**: When using self-fetching mode without explicit `imageSearchFilters` / `imageVariantFilters` props, the `configuration` prop is required (to provide `imageSearchFiltersGrid` and `imageVariantFiltersMedium` fallbacks). Omitting both will cause a runtime error. When a `cluster` prop is provided, image filters are not used.

- **Visible output**: The component renders only the cluster name (as an `<h1>`) and the SKU. Both can be independently toggled off. All other fetched data (products, images, prices, attributes) is surfaced only through the `onClusterLoaded` callback for use by sibling components.

---

## GraphQL Query Example

The underlying `ClusterService.getCluster()` call translates roughly to:

```graphql
query GetCluster(
  $clusterId: Int!
  $language: String
  $imageSearchFilters: ImageSearchInput
  $imageVariantFilters: ImageVariantFilterInput
  $priceCalculateProductInput: PriceCalculateProductInput
  $attributeResultSearchInput: AttributeResultSearchInput
) {
  cluster(
    clusterId: $clusterId
    language: $language
  ) {
    clusterId
    sku
    names {
      language
      value
    }
    products {
      items {
        productId
        sku
        names { language value }
        media(input: $imageSearchFilters) {
          images {
            items {
              url
              variants(input: $imageVariantFilters) {
                url
                width
                height
              }
            }
          }
        }
        price(input: $priceCalculateProductInput) {
          net
          gross
        }
        attributes(input: $attributeResultSearchInput) {
          items {
            attributeDescription { code name }
            textValue { language value }
          }
        }
      }
    }
    config {
      settings {
        name
        values { name value }
      }
    }
  }
}
```

Variables example:

```json
{
  "clusterId": 4821,
  "language": "EN",
  "imageSearchFilters": { "page": 1, "offset": 20 },
  "imageVariantFilters": { "transformations": [{ "name": "medium", "width": 400, "height": 400 }] },
  "priceCalculateProductInput": { "taxZone": "NL", "companyId": 100, "contactId": 200 },
  "attributeResultSearchInput": { "attributeDescription": { "names": ["color", "size"] } }
}
```

---

## SDK Services

The component uses two `ClusterService` methods when self-fetching:

### `ClusterService.getClusterConfig(clusterId)`

Called first to retrieve the cluster's configurable attribute settings. Reads:

| Field | Purpose |
|-------|---------|
| `config.settings[].name` | Attribute names from `ClusterConfigSetting`. Collected into an array and passed as `attributeResultSearchInput.attributeDescription.names` in the follow-up query so only relevant attributes are returned. |

### `ClusterService.getCluster(variables)`

Called second with a `ClusterQueryVariables` object built from props and the config settings. The component reads these fields from the returned `Cluster`:

| Field | Type | Purpose |
|-------|------|---------|
| `names` | `LocalizedString[]` | Array of localized name objects. The component matches against `language` to find the right translation. Falls back to the first entry if no match. |
| `sku` | `string` | The cluster's SKU code, displayed as a monospace label. |

### Price Calculation Input

When self-fetching, the component builds a `priceCalculateProductInput` from the `user` prop:

- **Contact (B2B)**: includes `companyId` and `contactId`
- **Customer (B2C)**: includes `customerId`
- Always includes `taxZone`

This ensures the fetched cluster data contains user-specific pricing.

---

## ClusterOptions

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/clusters/cluster-options

# ClusterOptions

Renders a set of option groups for a product cluster, each displayed as a dropdown selector. When a user picks a product from any option group, the component shows a preview card with the product thumbnail, name, and price. Required options are marked with a badge and validated on demand.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage on a cluster detail page

```tsx


<ClusterOptions
  clusterId={42}
  options={cluster.options}
  onOptionSelect={(product) => console.log('Selected:', product.productId)}
/>
```

### With validation errors

Pass `showErrors={true}` to highlight required options that have no selection. Typically toggled before an add-to-cart action:

```tsx
const [showErrors, setShowErrors] = useState(false);

const validateBeforeAddToCart = (): boolean => {
  const hasUnfilled = cluster.options.some(
    opt => opt.hidden !== 'Y' && opt.isRequired === 'Y' && !(opt.id in selectedOptionProducts)
  );
  if (hasUnfilled) {
    setShowErrors(true);
    return false;
  }
  return true;
};

<ClusterOptions
  clusterId={clusterId}
  options={cluster.options}
  onOptionSelect={handleOptionSelect}
  showErrors={showErrors}
/>

<AddToCart beforeAddToCart={validateBeforeAddToCart} childItems={Object.values(selectedOptionProducts).map(p => p.productId)} />
```

### Tracking selected option products for add-to-cart

The parent page should maintain a map of selected option products and pass them as `childItems` to `AddToCart`:

```tsx
const [selectedOptionProducts, setSelectedOptionProducts] = useState<Record<number, Product>>({});

const handleOptionSelect = (product: Product) => {
  const option = cluster?.options?.find(opt =>
    opt.products?.some(p => p.productId === product.productId)
  );
  if (option) {
    setSelectedOptionProducts(prev => ({ ...prev, [option.id]: product }));
  }
};

<ClusterOptions
  clusterId={clusterId}
  options={cluster.options}
  onOptionSelect={handleOptionSelect}
  showErrors={showErrors}
/>
```

### Custom labels

```tsx
<ClusterOptions
  clusterId={clusterId}
  options={cluster.options}
  labels={{
    required: 'Verplicht',
    selectRequired: '— Maak een keuze —',
    selectOptional: '— Geen (optioneel) —',
    requiredError: 'Dit veld is verplicht',
  }}
/>
```

### With custom styling

```tsx
<ClusterOptions
  clusterId={clusterId}
  options={cluster.options}
  className="my-8 border-t pt-6"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom cluster options component, you need to handle:

1. **Filter hidden options** -- Exclude any option where `hidden === 'Y'` from your rendered output.
2. **Render each option group** -- Loop through visible options, display `option.names[0].value` as the group label, and render each `option.products` entry as a selectable choice.
3. **Track selections** -- Maintain a `Record<number, string>` (option ID to product ID) for internal state. On each selection change, look up the full `Product` object from `option.products` and pass it to the parent via a callback.
4. **Validate required options** -- Check `option.isRequired === 'Y'`. When the parent signals validation (e.g., before add-to-cart), highlight unfilled required groups.
5. **Show a preview** -- After selection, display the product image from `product.media.images.items[0].imageVariants[0].url`, the name from `product.names[0].value`, and the price from `product.price.gross`.
6. **Pass child items to AddToCart** -- The parent should collect all selected product IDs (`Object.values(selectedOptionProducts).map(p => p.productId)`) and pass them as the `childItems` prop to `AddToCart`.

### Core logic

```ts


// Filter out hidden options
function getVisibleOptions(options: ClusterOption[]): ClusterOption[] {
  return options.filter(opt => opt.hidden !== 'Y');
}

// Track selections as a map of option ID to selected Product
// pseudo-code: maintain a selections record, e.g. Record<number, Product>

// Handle a selection change
function handleSelect(
  selections: Record<number, Product>,
  option: ClusterOption,
  productId: number
): { updatedSelections: Record<number, Product>; selectedProduct: Product | undefined } {
  const product = option.products?.find(p => p.productId === productId);
  if (!product) return { updatedSelections: selections, selectedProduct: undefined };
  return {
    updatedSelections: { ...selections, [option.id]: product },
    selectedProduct: product,
  };
}

// Validate required options before add-to-cart
function validateRequired(
  options: ClusterOption[],
  selections: Record<number, Product>
): boolean {
  return !getVisibleOptions(options).some(
    opt => opt.isRequired === 'Y' && !(opt.id in selections)
  );
}

// Collect selected product IDs for AddToCart's childItems prop
function getChildItems(selections: Record<number, Product>): number[] {
  return Object.values(selections).map(p => p.productId);
}
```

### With validation errors

```ts
// Before add-to-cart, validate required options
const isValid = validateRequired(cluster.options, selections);
if (!isValid) {
  // Set showErrors flag to highlight unfilled required groups
  // Each required option without a selection should display a red border and error message
}
```

### Tracking selected option products for add-to-cart

```ts
// Maintain a selections map and collect child items for AddToCart
const selections: Record<number, Product> = {};

function onOptionSelect(option: ClusterOption, productId: number) {
  const { updatedSelections, selectedProduct } = handleSelect(selections, option, productId);
  Object.assign(selections, updatedSelections);
  // Pass selectedProduct to parent callback
}

// When ready to add to cart:
const childItems = getChildItems(selections);
```

For each visible option, render a dropdown with `option.names[0].value` as the label and each `option.products` entry as a selectable choice (showing `product.names[0].value` and `product.price.gross` formatted as EUR). Mark required options with a badge. When `showErrors` is true and a required option has no selection, highlight it with an error state. After selection, show a preview card with the product thumbnail from `product.media.images.items[0].imageVariants[0].url`, the product name, and the price.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| `clusterId` | `number` | The cluster ID this options selector belongs to. |
| `options` | `ClusterOption[]` | Array of option groups from `cluster.options`. Hidden options (`option.hidden === 'Y'`) are filtered out automatically. |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onOptionSelect` | `(optionProduct: Product) => void` | Fired when the user selects a product in any option group. Receives the full `Product` object. Use this to update a price display or track selected products for add-to-cart. |

### Display & Validation

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showErrors` | `boolean` | `false` | When `true`, required options without a selection display a red border and error message. |
| `labels` | `Record<string, string>` | Built-in English defaults | Override UI strings. Keys: `required`, `selectRequired`, `selectOptional`, `requiredError`. |
| `className` | `string` | `''` | Extra CSS class applied to the root `<div>`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


function buildClusterOptions(
  clusterId: number,
  options: ClusterOption[]
): {
  visibleOptions: ClusterOption[];
  selections: Record<number, Product>;
}
```

### Options table

| Field | Type | Default | Maps to |
|------|------|---------|---------|
| `clusterId` | `number` | -- | The cluster ID the options belong to |
| `options` | `ClusterOption[]` | -- | Array of option groups; hidden options (`hidden === 'Y'`) are filtered out |
| `showErrors` | `boolean` | `false` | Triggers validation display for unfilled required options |

### Callbacks table

| Callback | When it fires | What to implement |
|------|------|---------|
| `onOptionSelect` | User selects a product in any option group | Update parent state with the selected `Product`, track selections for add-to-cart |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `labels` -- UI string overrides (`required`, `selectRequired`, `selectOptional`, `requiredError`)
- `className` -- CSS class for styling
- `showErrors` -- controls validation error display

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default value | Where it appears |
|-----|---------------|------------------|
| `required` | `"Required"` | Badge next to required option names |
| `selectRequired` | `"-- Select an option --"` | Placeholder in required dropdowns |
| `selectOptional` | `"-- None (Optional) --"` | Placeholder in optional dropdowns |
| `requiredError` | `"This option is required"` | Error text below unfilled required dropdowns |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  required: 'Required',
  selectRequired: '-- Select an option --',
  selectOptional: '-- None (Optional) --',
  requiredError: 'This option is required',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Option selection flow

1. Each option group renders as a `<select>` dropdown. The default value is empty (placeholder text).
2. When the user picks a product, the component stores the selection internally (`selectedProductIds` state keyed by option ID).
3. If an `onOptionSelect` callback is provided, it fires with the full `Product` object of the selected item.
4. A preview card appears below the dropdown showing the selected product's thumbnail, name, and price.

### Visual presentation

- **Option header**: Option name in semibold text. Required options show a red "Required" badge.
- **Dropdown**: Full-width `<select>` with rounded borders. Required options have a slightly heavier border (`border-gray-300`); optional ones use `border-gray-200`. Focus ring uses the `secondary` theme color.
- **Validation errors**: When `showErrors` is `true` and a required option has no selection, the dropdown border turns red (`border-red-400`) and an error message appears below it.
- **Preview card**: A horizontal card with a 48x48px thumbnail (or an SVG placeholder if no image is available), the product name (truncated), and the price in the `secondary` theme color.
- **Price formatting**: All prices render as EUR with two decimal places (e.g., `€10.00`). The `price.gross` value (excl. VAT) is used in the dropdown labels and preview.

### Hidden options

Options where `option.hidden === 'Y'` are filtered out before rendering. They never appear in the UI.

### State management

The component manages its own selection state internally. There is no controlled mode -- the parent tracks selections through the `onOptionSelect` callback rather than passing selected values back in.

---

## GraphQL Query

The component does not execute queries directly. The parent page fetches the cluster via `ClusterService.getCluster()`, which returns `cluster.options`. A typical query that includes the fields ClusterOptions needs:

```graphql
query GetCluster($clusterId: Int!, $language: String) {
  cluster(id: $clusterId, language: $language) {
    clusterId
    options {
      id
      hidden
      isRequired
      names {
        value
        language
      }
      products {
        productId
        names {
          value
          language
        }
        price {
          gross
          net
        }
        media {
          images(searchInput: { limit: 1 }) {
            items {
              imageVariants {
                url
              }
            }
          }
        }
      }
    }
  }
}
```

---

## SDK Services

ClusterOptions does not fetch data itself. It receives `ClusterOption[]` from the parent, which typically comes from a `ClusterService.getCluster()` call.

### ClusterOption fields read

| Field | Type | Usage |
|-------|------|-------|
| `option.id` | `number` | Unique key for each option group |
| `option.names` | `{ value: string }[]` | Display name (first entry used). Falls back to `"Option {id}"`. |
| `option.hidden` | `Enums.YesNo` | Options with `hidden === 'Y'` are excluded from rendering |
| `option.isRequired` | `Enums.YesNo` | `'Y'` marks the option as required (badge + validation) |
| `option.products` | `Product[]` | The selectable products within this option group |

### Product fields read (from each option product)

| Field | Type | Usage |
|-------|------|-------|
| `product.productId` | `number` | Unique identifier, used as `<option value>` and for lookup |
| `product.names` | `{ value: string }[]` | Display name (first entry). Falls back to `"Product {productId}"`. |
| `product.price.gross` | `number` | Price displayed in the dropdown label and preview card (formatted as EUR) |
| `product.media.images.items[].imageVariants[].url` | `string` | Thumbnail URL for the selected-product preview card |

---

## AddToFavorite

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/favorites/add-to-favorite

# AddToFavorite

A self-contained heart-toggle component that lets authenticated users add or remove a product or cluster from their favorite lists. Renders a heart icon button that opens a modal with list selection.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic product favorite button

```tsx
<AddToFavorite
  graphqlClient={graphqlClient}
  user={user}
  productId={12345}
/>
```

### Cluster favorite button

```tsx
<AddToFavorite
  graphqlClient={graphqlClient}
  user={user}
  clusterId={678}
/>
```

### With custom labels and styling

```tsx
<AddToFavorite
  graphqlClient={graphqlClient}
  user={user}
  productId={12345}
  className="my-custom-class"
  labels={{
    modalTitle: 'Save this product?',
    addToFavorites: 'Save',
    removeFromFavorites: 'Unsave',
    chooseList: 'Pick a list*',
    adding: 'Saving...',
    removing: 'Unsaving...',
    noLists: 'No lists yet. Create one in your account.',
  }}
/>
```

### Inside a product card

```tsx
<div className="relative">
  <ProductImage src={product.image} />
  <div className="absolute top-2 right-2">
    <AddToFavorite
      graphqlClient={graphqlClient}
      user={user}
      productId={product.productId}
    />
  </div>
</div>
```

### Inside a cluster detail page

```tsx
function ClusterDetailPage({ cluster, user, graphqlClient }) {
  return (
    <div className="flex items-center gap-4">
      <h1>{cluster.name}</h1>
      <AddToFavorite
        graphqlClient={graphqlClient}
        user={user}
        clusterId={cluster.clusterId}
      />
    </div>
  );
}
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom favorite toggle, you need three things:

1. **Determine membership** -- Read the user's `favoriteLists.items` array. For each list, check `list.products.items` for matching `productId` or `clusterId`. No extra API call is needed since favorite list contents are included in the user object.

2. **Add/remove via FavoriteListService** -- Instantiate the service with a `GraphQLClient` and call `addFavoriteListItems` or `removeFavoriteListItems` with the list ID and an input object containing `productIds` or `clusterIds`.

3. **Refresh user data after mutation** -- After adding or removing, call `refreshUser()` from AuthContext on the parent page. The component itself only fires `onFavoriteChanged` -- it does not refresh the user object internally.

```ts
const service = new FavoriteListService(graphqlClient);

// Add
await service.addFavoriteListItems(listId, { productIds: [productId] });

// Remove
await service.removeFavoriteListItems(listId, { productIds: [productId] });

// Parent page wires onFavoriteChanged to refreshUser():
// <AddToFavorite ... onFavoriteChanged={() => refreshUser()} />
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| `graphqlClient` | `GraphQLClient` | Initialized SDK client for API calls |
| `user` | `Contact \| Customer \| null` | Authenticated user object. Component renders nothing when `null` |

### Item identification (provide one)

| Prop | Type | Description |
|------|------|-------------|
| `productId` | `number` | Product ID to favorite. Takes precedence over `clusterId` |
| `clusterId` | `number` | Cluster ID to favorite. Used when `productId` is not set |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onFavoriteChanged` | `() => void` | Called after a favorite list mutation (add/remove) succeeds. Wire this to `refreshUser()` on the parent page to sync the user object |

### Customization

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `className` | `string` | `''` | Extra CSS class on the root button element |
| `labels` | `Record<string, string>` | See below | UI string overrides |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
// Add to a favorite list
async function addFavoriteListItems(
  listId: string,
  input: { productIds?: number[]; clusterIds?: number[] }
): Promise<FavoriteList>

// Remove from a favorite list
async function removeFavoriteListItems(
  listId: string,
  input: { productIds?: number[]; clusterIds?: number[] }
): Promise<FavoriteList>
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `listId` | `string` | *required* | First argument to `addFavoriteListItems` / `removeFavoriteListItems` |
| `productIds` | `number[]` | -- | `input.productIds` |
| `clusterIds` | `number[]` | -- | `input.clusterIds` |

### Callbacks table

| Callback | Purpose |
|---|---|
| `onFavoriteChanged` | Notify parent to refresh user data after a mutation |

### UI-only props (no SDK equivalent)

The following props control visual presentation only and have no SDK counterpart: `className`, `labels`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default |
|-----|---------|
| `modalTitle` | `'Favorite product?'` |
| `addToFavorites` | `'Add to favorites'` |
| `removeFromFavorites` | `'Remove from favorites'` |
| `chooseList` | `'Choose a favorites list*'` |
| `adding` | `'Adding...'` |
| `removing` | `'Removing...'` |
| `noLists` | `'You have no favorite lists. Create one in your account first.'` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  modalTitle: 'Favorite product?',
  addToFavorites: 'Add to favorites',
  removeFromFavorites: 'Remove from favorites',
  chooseList: 'Choose a favorites list*',
  adding: 'Adding...',
  removing: 'Removing...',
  noLists: 'You have no favorite lists. Create one in your account first.',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Heart icon state

The heart button has two visual states:

- **Unfavorited** (outline heart) -- The item is not in any of the user's favorite lists. The button has a gray border and gray icon, with a hover effect that transitions to the primary color.
- **Favorited** (filled heart) -- The item is in at least one favorite list. The button uses the primary color with a subtle background tint.

The icon state is derived from `memberListIds.size > 0`. Membership is computed locally from the user's `favoriteLists.items` -- no separate API call is made to check membership.

### Toggle behavior

Clicking the heart button opens a centered modal overlay. The modal shows:

1. **Member lists** (lists that already contain this item) -- Each displayed with a checked checkbox icon. Clicking a list removes the item from that list. A "Remove from favorites" button removes the item from the first member list.
2. **Non-member lists** (lists that do not contain this item) -- Shown in a dropdown selector. Selecting a list and clicking "Add to favorites" adds the item.
3. **No lists** -- If the user has no favorite lists at all, a message prompts them to create one in their account.

### List selection

The dropdown for adding to a list shows only lists where the item is **not** already a member. After adding, that list moves to the "member lists" section. After removing from all lists, the heart icon reverts to the outline (unfavorited) state.

### Optimistic updates

After a successful add or remove, the component updates `memberListIds` immediately so the UI reflects the change instantly. It then calls `onFavoriteChanged` so the parent can refresh the user object. Loading flags (`addLoading` / `removeLoading`) prevent duplicate API calls while a mutation is in flight.

### List selection

When the modal opens, the first non-member list is auto-selected in the dropdown. After each add or remove operation, `selectedListId` is reset to empty.

### Authentication guard

The entire component is wrapped in a `Show when={props.user}` guard. When the user is `null` (not logged in), nothing renders. There is no unauthenticated fallback -- the button simply does not appear.

### Hydration safety

The modal is guarded by `_isMounted` state to prevent hydration mismatches. The mount flag is set on the client side only, so the modal overlay never renders during server-side rendering.

## GraphQL Mutations

### addFavoriteListItems

```graphql
mutation addFavoriteListItems($listId: String!, $input: FavoriteListItemsInput!) {
  addFavoriteListItems(favoriteListId: $listId, input: $input) {
    id
    name
    products {
      items {
        productId
        clusterId
      }
    }
  }
}
```

Called with:

```ts
// For a product
service.addFavoriteListItems("42", { productIds: [12345] });

// For a cluster
service.addFavoriteListItems("42", { clusterIds: [678] });
```

### removeFavoriteListItems

```graphql
mutation removeFavoriteListItems($listId: String!, $input: FavoriteListItemsInput!) {
  removeFavoriteListItems(favoriteListId: $listId, input: $input) {
    id
    name
    products {
      items {
        productId
        clusterId
      }
    }
  }
}
```

Called with the same input shape as add.

## SDK Services

The component uses **`FavoriteListService`** from `propeller-sdk-v2` internally:

- **`addFavoriteListItems(listId, input)`** -- Adds a product or cluster to a favorite list. Input is `{ productIds: [id] }` or `{ clusterIds: [id] }`.
- **`removeFavoriteListItems(listId, input)`** -- Removes a product or cluster from a favorite list. Same input shape.

The component does **not** call `UserService.getViewer()` or refresh user data itself. Instead, after a successful mutation it calls the `onFavoriteChanged` callback, and the parent page is responsible for refreshing the user object (e.g., via `AuthContext.refreshUser()`).

---

## FavoriteListDetails

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/favorites/favorite-list-details

# FavoriteListDetails

Renders the contents of a favorite list, displaying products and clusters with client-side pagination. Each item is rendered via `FavoriteListItem` and supports add-to-cart, deletion, stock display, and navigation.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Full integration on a favorites detail page

```tsx






const graphqlClient = getGraphqlClient();
const { state: authState } = useAuth();
const { cart, saveCart } = useCart();

<FavoriteListDetails
  graphqlClient={graphqlClient}
  user={authState.user}
  favoriteListId={listId}
  onItemDelete={handleItemDelete}
  onListLoaded={(list) => setPageTitle(list.name)}
  configuration={config}
  cartId={cart?.cartId}
  createCart={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  itemsPerPage={12}
  showPagination={true}
/>
```

### Read-only display (no cart actions, no delete)

```tsx
<FavoriteListDetails
  graphqlClient={graphqlClient}
  user={authState.user}
  favoriteListId={listId}
  allowAddToCart={false}
  showDelete={false}
  showPagination={false}
/>
```

### Compact preview with limited items per page

```tsx
<FavoriteListDetails
  graphqlClient={graphqlClient}
  user={authState.user}
  favoriteListId={listId}
  itemsPerPage={4}
  paginationVariant="compact"
  showStockComponent={true}
  showSku={false}
  labels={{
    emptyTitle: 'No items yet',
    emptyDescription: 'Start adding products to this list.',
  }}
/>
```

### Full pagination variant with custom item labels

```tsx
<FavoriteListDetails
  graphqlClient={graphqlClient}
  user={authState.user}
  favoriteListId={listId}
  itemsPerPage={6}
  paginationVariant="full"
  itemLabels={{ deleteButton: 'Remove', viewCluster: 'View options' }}
  addToCartLabels={{ addButton: 'Add to basket' }}
/>
```

### With stock validation and checkout flow

```tsx
<FavoriteListDetails
  graphqlClient={graphqlClient}
  user={authState.user}
  favoriteListId={listId}
  cartId={cart?.cartId}
  createCart={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  showStockComponent={true}
  showAvailability={true}
  showStock={true}
  enableStockValidation={true}
  showModal={true}
  onProceedToCheckout={() => router.push('/checkout')}
  configuration={config}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom favorite list detail view, you need:

1. **Fetch the list** -- Create a `FavoriteListService` and call `getFavoriteList()` with the list ID, language, price input, and image filters.

2. **Merge products and clusters** -- The response separates products and clusters into two `ProductsResponse` objects. Combine them into a single array for rendering.

3. **Handle pagination** -- The SDK returns all items at once. Slice the merged array client-side based on page size and current page.

4. **Handle deletion** -- Remove the item from local state optimistically, then call the SDK to persist the deletion. The `FavoriteListService` provides `removeProductFromFavoriteList()` and `removeClusterFromFavoriteList()` for this.

5. **Determine item type** -- Check for `productId` vs `clusterId` on each item to distinguish products from clusters. This matters for deletion (different SDK methods) and for display (clusters show "View cluster" instead of add-to-cart).

```tsx


const service = new FavoriteListService(graphqlClient);

// Fetch
const list = await service.getFavoriteList({
  id: listId,
  language: 'NL',
  priceCalculateProductInput: { taxZone: 'NL', customerId: user.customerId },
  imageSearchFilters: { page: 1, offset: 1 },
  imageVariantFilters: {
    transformations: [{
      name: 'cart_thumb',
      transformation: { format: 'WEBP', height: 200, width: 200, fit: 'BOUNDS' },
    }],
  },
});

// Merge items
const allItems = [
  ...(list.products?.items || []),
  ...(list.clusters?.items || []),
];

// Delete a product
await service.removeProductFromFavoriteList({
  favoriteListId: listId,
  productId: itemId,
});

// Delete a cluster
await service.removeClusterFromFavoriteList({
  favoriteListId: listId,
  clusterId: itemId,
});
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | Yes | -- | GraphQL client instance for the Propeller SDK |
| `user` | `Contact \| Customer` | Yes | -- | Logged-in user whose favorite list is displayed |
| `favoriteListId` | `string` | Yes | -- | ID of the favorite list to fetch |
| `configuration` | `object` | No | -- | Configuration object for URL generation (e.g., `config` from `@/data/config`) |
| `className` | `string` | No | -- | Extra CSS class on the root element |
| `language` | `string` | No | `'NL'` | Language code forwarded to the SDK for localized data |
| `includeTax` | `boolean` | No | -- | Whether prices include tax. Pass from your price context |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onItemDelete` | `(itemId: string, itemType: string) => void` | Called after an item is optimistically removed. `itemType` is `'product'` or `'cluster'`. The parent should perform the actual SDK deletion |
| `onListLoaded` | `(list: FavoriteList) => void` | Called after the favorite list is fetched, with the full list object. Useful for setting the page title |
| `onItemClick` | `(item: Product \| Cluster) => void` | Called when an item title or image is clicked |

### Item Display

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `titleLinkable` | `boolean` | `true` | Whether item titles link to the product detail page |
| `showStockComponent` | `boolean` | `false` | Show stock availability indicator on items |
| `showAvailability` | `boolean` | `true` | Show availability status text (e.g., "In stock") inside stock indicator |
| `showStock` | `boolean` | `true` | Show numeric stock quantity inside stock indicator |
| `showSku` | `boolean` | `true` | Display the SKU beneath item names |
| `allowAddToCart` | `boolean` | `true` | Enable add-to-cart for products. Clusters show a "View cluster" link instead |
| `showDelete` | `boolean` | `true` | Show the delete button on each item |

### Pagination

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `itemsPerPage` | `number` | `12` | Number of items shown per page |
| `showPagination` | `boolean` | `true` | Show pagination controls below items |
| `paginationVariant` | `string` | `'compact'` | Pagination style: `'compact'` or `'full'` |

### Add-to-Cart (passed through to each FavoriteListItem / AddToCart)

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `cartId` | `string` | -- | Existing cart ID to add items to |
| `createCart` | `boolean` | -- | Auto-create a cart if none exists |
| `onCartCreated` | `(cart: Cart) => void` | -- | Called when a new cart is created internally |
| `onAddToCart` | `(product, clusterId?, quantity?, childItems?, notes?, price?, showModal?) => Cart` | -- | Fully replaces the internal add-to-cart call |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | -- | Called after every successful add-to-cart |
| `showModal` | `boolean` | `false` | Show confirmation modal after adding to cart |
| `allowIncrDecr` | `boolean` | `true` | Render increment/decrement buttons beside quantity input |
| `enableStockValidation` | `boolean` | `false` | Validate available stock before adding to cart |
| `onProceedToCheckout` | `() => void` | -- | Called when "Proceed to checkout" is clicked in the add-to-cart modal |

### Labels

| Prop | Type | Description |
|------|------|-------------|
| `labels` | `Record<string, string>` | UI string overrides for the component itself (see below) |
| `addToCartLabels` | `Record<string, string>` | Label overrides passed to AddToCart |
| `stockLabels` | `Record<string, string>` | Label overrides passed to ItemStock |
| `itemLabels` | `Record<string, string>` | Label overrides passed to FavoriteListItem |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchFavoriteListDetails(options: FavoriteListDetailsOptions): Promise<FavoriteListResult>
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `graphqlClient` | `GraphQLClient` | (required) | `graphqlClient` prop |
| `user` | `Contact \| Customer` | (required) | `user` prop |
| `favoriteListId` | `string` | (required) | `favoriteListId` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `includeTax` | `boolean` | `true` | `includeTax` prop |
| `itemsPerPage` | `number` | `12` | `itemsPerPage` prop |

### Cart resolution

When integrating cart functionality:

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `cartId` | `string` | -- | `cartId` prop |
| `createCart` | `boolean` | -- | `createCart` prop |

### Callbacks

| Field | Type | Maps to |
|-------|------|---------|
| `onItemDelete` | `(itemId: string, itemType: string) => void` | `onItemDelete` prop |
| `onListLoaded` | `(list: FavoriteList) => void` | `onListLoaded` prop |
| `onItemClick` | `(item: Product \| Cluster) => void` | `onItemClick` prop |
| `onCartCreated` | `(cart: Cart) => void` | `onCartCreated` prop |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | `afterAddToCart` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `className` -- CSS class on root element
- `titleLinkable` -- Link styling for item titles
- `showStockComponent`, `showAvailability`, `showStock`, `showSku` -- Display toggles
- `allowAddToCart`, `showDelete` -- Action visibility toggles
- `showPagination`, `paginationVariant` -- Pagination display options
- `showModal`, `allowIncrDecr` -- AddToCart UI options
- `configuration` -- URL generation config (implement your own URL scheme)

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

**`labels` keys:**

| Key | Default |
|-----|---------|
| `emptyTitle` | `"List is empty"` |
| `emptyDescription` | `"You haven't added any products or clusters to this list yet."` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  emptyTitle: "List is empty",
  emptyDescription: "You haven't added any products or clusters to this list yet.",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Data fetching**: Fetches the favorite list on mount via `FavoriteListService.getFavoriteList()`. Re-fetches automatically whenever `favoriteListId` changes. Tracks the previous list ID internally to prevent duplicate fetches when the same ID is passed.
- **User-aware pricing**: Price calculation variables adapt to the user type -- `customerId` for B2C customers, `contactId` and `companyId` for B2B contacts.
- **Client-side pagination**: The SDK returns all items in a single response. The component slices the combined products + clusters array based on `itemsPerPage` and the current page.
- **Optimistic delete**: When an item is deleted, it is immediately removed from the local array before calling the `onItemDelete` callback. The parent is responsible for the actual SDK deletion call.
- **Page adjustment**: After removing an item, if the current page exceeds the new total page count, the component automatically navigates to the last available page.
- **Loading skeleton**: While fetching, three placeholder rows with animated pulse styling are shown.
- **Empty state**: When the list contains no items, a centered message with a heart icon and customizable text is displayed.
- **Hydration safety**: Uses an `isMounted` guard to prevent rendering client-only content during server-side rendering.
- **Item type detection**: Products are identified by the presence of `productId`, clusters by `clusterId`. This determines whether add-to-cart or a "View cluster" link is shown.

## SDK Services

The component uses **`FavoriteListService`** from `propeller-sdk-v2` to fetch the favorite list and its items.

### How it works

1. A `FavoriteListService` instance is created from the provided `graphqlClient`.
2. `service.getFavoriteList(variables)` is called with variables built internally from props.
3. The response contains the list metadata plus `products` and `clusters` as `ProductsResponse` objects. Both are merged into a single array for display.

### Variables built internally

The component constructs query variables automatically based on props:

```ts
{
  id: props.favoriteListId,
  language: props.language || 'NL',
  priceCalculateProductInput: {
    taxZone: 'NL',
    customerId: /* from user if Customer */,
    contactId: /* from user if Contact */,
    companyId: /* from user.company if Contact */,
  },
  imageSearchFilters: { page: 1, offset: 1 },
  imageVariantFilters: {
    transformations: [{
      name: 'cart_thumb',
      transformation: { format: 'WEBP', height: 200, width: 200, fit: 'BOUNDS' },
    }],
  },
}
```

Price calculation input adapts to the user type: `customerId` for B2C `Customer` users, `contactId` + `companyId` for B2B `Contact` users.

**Note:** `taxZone` is hardcoded to `'NL'` — there is no prop to override it (unlike ProductGrid which accepts a `taxZone` prop). Image filters are also hardcoded to `page: 1, offset: 1` search filters and `cart_thumb` 200x200 WEBP variant.

## GraphQL Queries and Mutations

The SDK's `FavoriteListService.getFavoriteList()` sends a query similar to:

```graphql
query FavoriteList(
  $id: String!
  $language: String
  $priceCalculateProductInput: PriceCalculateProductInput
  $imageSearchFilters: ImageSearchInput
  $imageVariantFilters: ImageVariantSearchInput
) {
  favoriteList(id: $id) {
    id
    name
    description
    products(
      language: $language
      calculatePrice: $priceCalculateProductInput
    ) {
      items {
        productId
        sku
        name {
          value
        }
        price {
          net
          gross
        }
        media(input: $imageSearchFilters) {
          images(input: $imageVariantFilters) {
            url
          }
        }
        inventory {
          totalQuantity
        }
      }
    }
    clusters(
      language: $language
      calculatePrice: $priceCalculateProductInput
    ) {
      items {
        clusterId
        sku
        name {
          value
        }
        price {
          net
          gross
        }
        media(input: $imageSearchFilters) {
          images(input: $imageVariantFilters) {
            url
          }
        }
      }
    }
  }
}
```

---

## FavoriteListItem

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/favorites/favorite-list-item

# FavoriteListItem

Renders a single product or cluster as a horizontal row within a favorite list. Products display an inline AddToCart widget; clusters display a "View cluster" button. Each row includes an image, name, optional SKU, price, stock badge, and action buttons (add to cart, delete).

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Standard favorite list page with cart integration

```tsx



{items.map((item) => (
  <FavoriteListItem
    key={item.productId ?? item.clusterId}
    item={item}
    graphqlClient={graphqlClient}
    user={authState.user}
    cartId={cart?.cartId}
    createCart={true}
    onCartCreated={(newCart) => saveCart(newCart)}
    afterAddToCart={(updatedCart) => saveCart(updatedCart)}
    configuration={config}
    onDelete={(itemId) => handleRemoveFromList(itemId)}
  />
))}
```

### Read-only display (no actions)

```tsx
<FavoriteListItem
  item={product}
  allowAddToCart={false}
  showDelete={false}
  configuration={config}
/>
```

### SPA navigation with custom click handler

```tsx
<FavoriteListItem
  item={cluster}
  configuration={config}
  onItemClick={(item) => router.push(getClusterUrl(item))}
  onDelete={(itemId) => handleRemoveFromList(itemId)}
/>
```

### Minimal display (image + name only)

```tsx
<FavoriteListItem
  item={product}
  showSku={false}
  showStockComponent={false}
  allowAddToCart={false}
  showDelete={false}
/>
```

### With stock display and custom labels

```tsx
<FavoriteListItem
  item={product}
  showStockComponent={true}
  showAvailability={true}
  showStock={true}
  graphqlClient={graphqlClient}
  user={authState.user}
  cartId={cart?.cartId}
  configuration={config}
  onDelete={(itemId) => handleRemoveFromList(itemId)}
  labels={{
    viewCluster: 'Bekijk cluster',
    delete: 'Verwijderen',
    inStock: 'Op voorraad',
    lowStock: 'Beperkte voorraad',
    outOfStock: 'Niet op voorraad',
  }}
  addToCartLabels={{ addToCart: 'In winkelwagen' }}
  stockLabels={{ inStock: 'Op voorraad' }}
/>
```

### With price excluding VAT

```tsx
<FavoriteListItem
  item={product}
  includeTax={false}
  graphqlClient={graphqlClient}
  configuration={config}
  onDelete={(itemId) => handleRemoveFromList(itemId)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom favorite list item component, you need to handle these concerns:

1. **Item type detection** -- Check for `'productId' in item` to distinguish products from clusters.

2. **Data extraction** -- Products and clusters have different shapes for names, SKU, images, and prices. Always use optional chaining since these fields can be null.

3. **URL generation** -- Use the configuration object's URL helpers (`getProductUrl`, `getClusterUrl`) or build URLs manually from the item's slug/ID.

4. **Price display** -- Read `price.net` (incl. VAT) or `price.gross` (excl. VAT) depending on the user's preference. For clusters, use `defaultProduct.price`.

5. **Stock display** -- Products have a full `inventory` object compatible with the ItemStock component. Clusters only expose `defaultProduct.inventory.totalQuantity`, so you need simpler threshold-based logic (e.g., > 5 = in stock, 1-5 = low, 0 = out of stock).

6. **Cart integration** -- Use the AddToCart component or call `CartService.addItemToCart()` directly. Clusters cannot be added to cart directly; the user must visit the cluster page first.

7. **Delete handling** -- Call `FavoriteListService.removeFavoriteListItem()` with the list ID and item ID. Update local state optimistically for a responsive UI.

```tsx
// Minimal custom implementation skeleton
function CustomFavoriteItem({ item, onDelete, graphqlClient, cartId }) {
  const isProduct = 'productId' in item;
  const name = item.names?.[0]?.value || 'Unnamed';
  const price = isProduct
    ? item.price?.net
    : item.defaultProduct?.price?.net;

  return (
    <div className="flex items-center gap-4 p-4 border rounded">
      <span>{name}</span>
      {price != null && <span>EUR {price.toFixed(2)}</span>}

      {isProduct && graphqlClient && (
        <AddToCart
          graphqlClient={graphqlClient}
          product={item}
          cartId={cartId}
        />
      )}

      <button onClick={() => onDelete(
        String(isProduct ? item.productId : item.clusterId)
      )}>
        Remove
      </button>
    </div>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `item` | `Product \| Cluster` | Yes | -- | The product or cluster to display |
| `configuration` | `object` | No | -- | Configuration object for URL generation (e.g., `config` from `@/data/config`). Must expose `urls.getProductUrl()` and `urls.getClusterUrl()` |
| `className` | `string` | No | -- | Extra CSS class applied to the root element |

### Display Options

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `titleLinkable` | `boolean` | No | `true` | Whether the item name and image link to the product detail page |
| `showSku` | `boolean` | No | `true` | Display the SKU beneath the item name |
| `showStockComponent` | `boolean` | No | `false` | Display stock availability badge |
| `showAvailability` | `boolean` | No | `true` | Show availability status text inside ItemStock (products only) |
| `showStock` | `boolean` | No | `true` | Show numeric stock quantity inside ItemStock (products only) |
| `includeTax` | `boolean` | No | `true` | Include tax in the displayed price. When provided, overrides the internal PriceToggle localStorage state |

### Action Props

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `allowAddToCart` | `boolean` | No | `true` | Show the AddToCart widget for products. Clusters always show a "View cluster" button instead |
| `showDelete` | `boolean` | No | `true` | Show the delete (trash) button |
| `onDelete` | `(itemId: string) => void` | No | -- | Callback when the delete button is clicked. Receives the product ID or cluster ID as a string |
| `onItemClick` | `(item: Product \| Cluster) => void` | No | -- | Callback when the row, item name, or image is clicked. Prevents default `<a>` navigation when provided |

### Label Overrides

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `labels` | `Record<string, string>` | No | -- | UI string overrides for the component itself (see Labels section below) |
| `addToCartLabels` | `Record<string, string>` | No | -- | Label overrides forwarded to the embedded AddToCart component |
| `stockLabels` | `Record<string, string>` | No | -- | Label overrides forwarded to the embedded ItemStock component |

### AddToCart Pass-Through Props (products only)

These props are forwarded to the embedded AddToCart component and only take effect when the item is a product.

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | No | -- | Propeller SDK GraphQL client. Required for add-to-cart functionality |
| `user` | `Contact \| Customer \| null` | No | -- | Authenticated user for cart operations |
| `cartId` | `string` | No | -- | Existing cart ID to add items to |
| `createCart` | `boolean` | No | -- | Auto-create a new cart if no `cartId` is available |
| `onCartCreated` | `(cart: Cart) => void` | No | -- | Called after a new cart is created internally |
| `onAddToCart` | `(product, clusterId?, quantity?, childItems?, notes?, price?, showModal?) => Cart` | No | -- | Fully replaces the internal CartService.addItemToCart call |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | No | -- | Called after every successful add-to-cart |
| `showModal` | `boolean` | No | `false` | Show confirmation modal after a successful add |
| `allowIncrDecr` | `boolean` | No | `true` | Show increment/decrement buttons beside the quantity input |
| `enableStockValidation` | `boolean` | No | `false` | Validate available stock before adding to cart |
| `language` | `string` | No | `'NL'` | Language code forwarded to CartService |
| `onProceedToCheckout` | `() => void` | No | -- | Called when "Proceed to checkout" is clicked in the AddToCart modal |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function favoriteListItem(options: FavoriteListItemOptions): void
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `item` | `Product \| Cluster` | (required) | `item` prop |
| `graphqlClient` | `GraphQLClient` | -- | `graphqlClient` prop |
| `user` | `Contact \| Customer \| null` | -- | `user` prop |
| `cartId` | `string` | -- | `cartId` prop |
| `createCart` | `boolean` | -- | `createCart` prop |
| `includeTax` | `boolean` | `true` | `includeTax` prop |
| `language` | `string` | `'NL'` | `language` prop |

### Cart resolution

When integrating cart functionality:

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `cartId` | `string` | -- | `cartId` prop |
| `createCart` | `boolean` | -- | `createCart` prop |

### Callbacks

| Field | Type | Maps to |
|-------|------|---------|
| `onDelete` | `(itemId: string) => void` | `onDelete` prop |
| `onItemClick` | `(item: Product \| Cluster) => void` | `onItemClick` prop |
| `onCartCreated` | `(cart: Cart) => void` | `onCartCreated` prop |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | `afterAddToCart` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `className` -- CSS class on root element
- `titleLinkable` -- Link styling for item titles
- `showSku`, `showStockComponent`, `showAvailability`, `showStock` -- Display toggles
- `allowAddToCart`, `showDelete` -- Action visibility toggles
- `showModal`, `allowIncrDecr`, `enableStockValidation` -- AddToCart UI options
- `configuration` -- URL generation config (implement your own URL scheme)
- `labels`, `addToCartLabels`, `stockLabels` -- UI string overrides

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All labels are optional and fall back to English defaults:

| Key | Default | Description |
|-----|---------|-------------|
| `viewCluster` | `"View cluster"` | Button text for cluster items |
| `delete` | `"Remove from list"` | Delete button tooltip |
| `inStock` | `"In stock"` | Stock badge for clusters with quantity > 5 |
| `lowStock` | `"Low stock"` | Stock badge for clusters with quantity 1-5 |
| `outOfStock` | `"Out of stock"` | Stock badge for clusters with quantity 0 |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  viewCluster: "View cluster",
  delete: "Remove from list",
  inStock: "In stock",
  lowStock: "Low stock",
  outOfStock: "Out of stock",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Product vs Cluster Differences

| Feature | Product | Cluster |
|---------|---------|---------|
| Image source | `product.media.images.items[0]` | `cluster.defaultProduct.media.images.items[0]` |
| Name source | `product.names[0].value` | `cluster.names[0].value`, falls back to `defaultProduct.names[0].value` |
| SKU source | `product.sku` | `cluster.sku`, falls back to `defaultProduct.sku` |
| Price source | `product.price` | `cluster.defaultProduct.price` |
| Stock display | Full `ItemStock` component with availability and quantity | Simplified inline badge (In stock / Low stock / Out of stock) based on `defaultProduct.inventory.totalQuantity` |
| Primary action | AddToCart widget (quantity input + add button) | "View cluster" link button |
| Detection | Has `productId` property | Does not have `productId` property |

### Price Toggle

The component respects the global price toggle (VAT incl/excl):

- When `includeTax` prop is provided, it takes precedence over any internal state.
- When `includeTax` is omitted, the default is `true` (prices shown including VAT).
- Price mapping from the SDK: `price.net` = including VAT, `price.gross` = excluding VAT.
- Prices are formatted as euros with two decimal places (e.g., `EUR 12.50`).

### Remove from List

The delete button calls `onDelete(itemId)` where `itemId` is:
- `String(product.productId)` for products
- `String(cluster.clusterId)` for clusters

The component does not perform the API call itself. The parent must handle the actual removal via `FavoriteListService` and update local state accordingly.

### Add to Cart

For products, the embedded AddToCart component handles the full cart flow:
1. If no `cartId` is provided and `createCart` is `true`, a new cart is created automatically.
2. The product is added to the cart via `CartService.addItemToCart`.
3. `onCartCreated` fires if a new cart was created; `afterAddToCart` fires after every successful addition.
4. When `showModal` is `true`, a confirmation modal appears after adding.

Clusters do not support add-to-cart. They display a "View cluster" button that navigates to the cluster detail page, where the user can select a specific variant.

### Click Handling

The entire row is clickable. Clicking navigates to the product/cluster detail page using the URL from `configuration.urls.getProductUrl()` or `configuration.urls.getClusterUrl()`. When `onItemClick` is provided, it intercepts the click and calls the callback instead, allowing SPA navigation via `router.push()`. The action buttons area (add to cart, delete) stops event propagation to prevent triggering the row click.

### Image Fallback

When no image is available, an SVG placeholder icon is rendered instead of a broken image.

## SDK Services

### FavoriteListService

The component itself does not call any SDK service directly. The parent page is responsible for fetching favorite list items and handling deletion. A typical integration uses `FavoriteListService` to remove items:

```ts


const favoriteListService = new FavoriteListService(graphqlClient);

async function handleRemoveFromList(itemId: string) {
  await favoriteListService.removeFavoriteListItem({
    favoriteListId: listId,
    itemId,
  });
  // Re-fetch the list or optimistically remove from local state
  setItems((prev) => prev.filter((i) =>
    String('productId' in i ? i.productId : i.clusterId) !== itemId
  ));
}
```

### CartService (via AddToCart)

When `graphqlClient` is provided and the item is a product, the embedded AddToCart component uses `CartService` internally to add items to the cart:

```ts


const cartService = new CartService(graphqlClient);

// AddToCart handles this internally, but you can override via onAddToCart:
const updatedCart = await cartService.addItemToCart({
  cartId,
  productId: product.productId,
  quantity: 1,
});
```

## GraphQL Queries and Mutations

### Remove item from favorite list

```graphql
mutation RemoveFavoriteListItem($favoriteListId: Int!, $itemId: String!) {
  favoriteListRemoveItem(
    input: {
      favoriteListId: $favoriteListId
      itemId: $itemId
    }
  ) {
    id
    name
    items {
      productId
      clusterId
    }
  }
}
```

### Add product to cart (handled by embedded AddToCart)

```graphql
mutation AddToCart($cartId: String!, $productId: Int!, $quantity: Int!) {
  cartAddItem(
    input: {
      cartId: $cartId
      productId: $productId
      quantity: $quantity
    }
  ) {
    cartId
    items {
      productId
      quantity
      totalPrice
    }
    total {
      totalNet
      totalGross
    }
  }
}
```

---

## FavoriteLists

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/favorites/favorite-lists

# FavoriteLists

Displays a user's favorite lists with full CRUD support: inline renaming, delete confirmation modal, and a create modal. Lists can be limited to the most recently modified N items, making the component suitable for both dedicated pages and compact dashboard widgets.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Full favorites page

All lists visible, with edit/delete actions and a create button.

```tsx





export default function FavoritesPage() {
  const { state: authState } = useAuth();
  const router = useRouter();

  return (
    <FavoriteLists
      user={authState.user}
      graphqlClient={graphqlClient}
      onListClick={(id) => router.push(`/account/favorites/${id}`)}
    />
  );
}
```

### Dashboard widget with limit

Show only the 3 most recently modified lists, read-only, without the create button.

```tsx
<FavoriteLists
  user={authState.user}
  graphqlClient={graphqlClient}
  limit={3}
  showActions={false}
  allowFavoriteListCreate={false}
  onListClick={(id) => router.push(`/account/favorites/${id}`)}
/>
```

### Custom labels (localization)

Override any label for internationalization or branding.

```tsx
<FavoriteLists
  user={authState.user}
  graphqlClient={graphqlClient}
  onListClick={(id) => router.push(`/account/favorites/${id}`)}
  labels={{
    lastModified: 'Laatst gewijzigd',
    items: 'artikelen',
    defaultBadge: 'Standaard',
    createButton: 'Nieuwe lijst',
    createTitle: 'Nieuwe lijst aanmaken',
    deleteTitle: 'Lijst verwijderen',
    deleteConfirm: 'Weet je zeker dat je wilt verwijderen',
    deleteWarning: 'Deze actie kan niet ongedaan worden gemaakt.',
    noLists: 'Geen favorieten lijsten',
    noListsDescription: 'Maak een nieuwe lijst aan om je producten op te slaan.',
    createFirstList: 'Maak je eerste lijst',
  }}
/>
```

### Custom action handlers

Delegate create, edit, and delete to parent logic instead of using the built-in SDK calls.

```tsx
<FavoriteLists
  user={authState.user}
  graphqlClient={graphqlClient}
  onCreate={(data) => {
    // data: { name: string, isDefault: boolean }
    myCustomCreateHandler(data);
  }}
  onEdit={(listId, data) => {
    myCustomEditHandler(listId, data);
  }}
  onDelete={(listId) => {
    myCustomDeleteHandler(listId);
  }}
  onListClick={(id) => router.push(`/account/favorites/${id}`)}
/>
```

### Minimal read-only display

Strip all metadata and actions for a compact list-name-only view.

```tsx
<FavoriteLists
  user={authState.user}
  graphqlClient={graphqlClient}
  showDefaultIndicator={false}
  showLastModified={false}
  showItemsCount={false}
  showActions={false}
  allowFavoriteListCreate={false}
  onListClick={(id) => router.push(`/account/favorites/${id}`)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom favorite lists UI while reusing the same data layer:

1. **Initialize the service** with your `GraphQLClient` instance.
2. **Fetch lists** using `getFavoriteLists()` with the appropriate search input for your user type.
3. **Determine user type** by checking for the presence of `contactId` on the user object (`'contactId' in user`). Contact users are B2B; Customer users are B2C.
4. **Sort by recency** if needed: sort the returned `items` array by `updatedAt` descending and slice to your desired limit.
5. **Count items** per list using `list.products.itemsFound` and `list.clusters.itemsFound`. Fall back to `list.products.items.length` if `itemsFound` is not available.
6. **Handle default list switching**: before setting a new list as default, update the current default list to `isDefault: false` first, then set the new one. The API does not auto-unset the previous default.
7. **Error recovery**: wrap mutations in try/catch. On failure, refetch the full list from the API to restore consistent state.

### Service setup

```ts


const service = new FavoriteListService(graphqlClient);

// Determine user type
const isContact = 'contactId' in user;
const searchInput = isContact
  ? { contactId: user.contactId }
  : { customerId: user.customerId };
```

### Fetch lists

```ts
async function fetchLists(): Promise<FavoriteList[]> {
  const res = await service.getFavoriteLists(searchInput);
  return res.items || [];
}
```

### Create a list

```ts
async function createList(name: string, isDefault: boolean, currentLists: FavoriteList[]) {
  // If setting as default, unset the current default first
  if (isDefault) {
    const currentDefault = currentLists.find((l) => l.isDefault);
    if (currentDefault) {
      await service.updateFavoriteList(String(currentDefault.id), {
        name: currentDefault.name,
        isDefault: false,
      });
    }
  }

  await service.createFavoriteList({
    name,
    isDefault,
    ...(isContact
      ? { contactId: user.contactId }
      : { customerId: user.customerId }),
  });

  // Refetch to get server-assigned ID and timestamps
  return fetchLists();
}
```

### Rename a list

```ts
async function renameList(listId: string, name: string) {
  // pseudo-code: optimistically update the list name in local state
  try {
    await service.updateFavoriteList(listId, { name });
  } catch {
    // pseudo-code: on error, refetch full list from API to restore consistent state
  }
}
```

### Delete a list

```ts
async function deleteList(listId: string) {
  // pseudo-code: optimistically remove the list from local state
  try {
    await service.deleteFavoriteList(listId);
  } catch {
    // pseudo-code: on error, refetch full list from API to restore consistent state
  }
}
```

### Optimistic update pattern

For rename and delete operations, update the in-memory list immediately to provide instant visual feedback. If the API call fails, refetch the full list from the server to roll back to a consistent state. For create operations, call `onListChanged` which triggers `refreshUser()` on the parent page. The updated user object flows back as `props.user`, and the component re-reads lists automatically.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| `user` | `Contact \| Customer \| null` | The authenticated user. Lists are fetched for this user's `contactId` (B2B) or `customerId` (B2C). |
| `graphqlClient` | `GraphQLClient` | Initialized SDK GraphQL client used for all API calls. |

### Display options

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `limit` | `number` | `undefined` | When set, shows only the last N modified lists (sorted by `updatedAt` descending). `undefined` shows all. |
| `showDefaultIndicator` | `boolean` | `true` | Show a "Default" badge next to the default list. |
| `showLastModified` | `boolean` | `true` | Show the last modified date on each list card. |
| `showItemsCount` | `boolean` | `true` | Show the total number of products and clusters in each list. |
| `showActions` | `boolean` | `true` | Show edit and delete buttons on each list card. |
| `allowFavoriteListCreate` | `boolean` | `true` | Show the "Create New List" button (top of list and in empty state). |
| `className` | `string` | `undefined` | Custom CSS class applied to the root container. |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onListClick` | `(listId: string \| number) => void` | Called when a list card is clicked. Typically used for navigation. |
| `onCreate` | `(data: FavoriteListFormData) => void` | Override default create behavior. When provided, the component delegates to this callback instead of calling the SDK. |
| `onEdit` | `(listId: string, data: FavoriteListFormData) => void` | Override default edit behavior. When provided, the component delegates to this callback instead of calling the SDK. |
| `onDelete` | `(listId: string) => void` | Override default delete behavior. When provided, the component delegates to this callback instead of calling the SDK. |
| `onListChanged` | `() => void` | Called after any list mutation (create, edit, delete) succeeds. Wire this to `refreshUser()` to keep the user object's `favoriteLists` in sync. |

### Formatting and labels

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `formatDate` | `(dateString: string) => string` | `dd/mm/YYYY` | Custom date formatter. Receives the raw ISO date string, returns the display string. |
| `labels` | `object` | English defaults | Localization overrides (see Labels section below). |

### Types

```ts
interface FavoriteListFormData {
  name: string;
  isDefault: boolean;
}
```

This is the shape passed to `onCreate` and `onEdit` callbacks and used internally for create/update API calls.

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function manageFavoriteLists(options: FavoriteListsOptions): Promise<void>
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `user` | `Contact \| Customer \| null` | (required) | `user` prop |
| `graphqlClient` | `GraphQLClient` | (required) | `graphqlClient` prop |
| `limit` | `number` | `undefined` | `limit` prop |

### Callbacks

| Field | Type | Maps to |
|-------|------|---------|
| `onListClick` | `(listId: string \| number) => void` | `onListClick` prop |
| `onCreate` | `(data: FavoriteListFormData) => void` | `onCreate` prop |
| `onEdit` | `(listId: string, data: FavoriteListFormData) => void` | `onEdit` prop |
| `onDelete` | `(listId: string) => void` | `onDelete` prop |
| `onListChanged` | `() => void` | `onListChanged` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `showDefaultIndicator` -- Badge visibility
- `showLastModified` -- Date display toggle
- `showItemsCount` -- Item count display toggle
- `showActions` -- Edit/delete button visibility
- `allowFavoriteListCreate` -- Create button visibility
- `className` -- CSS class on root container
- `formatDate` -- Date formatting function
- `labels` -- UI string overrides

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All labels are optional. Provide any subset to override the English defaults.

| Key | Default | Used in |
|-----|---------|---------|
| `lastModified` | `"Last modified"` | Date label on each list card |
| `items` | `"items"` | Item count label on each list card |
| `products` | `"products"` | Product count (if shown separately) |
| `clusters` | `"clusters"` | Cluster count (if shown separately) |
| `defaultBadge` | `"Default"` | Badge text on the default list |
| `editSave` | `"Save"` | Save button in inline edit form |
| `editCancel` | `"Cancel"` | Cancel button in inline edit form |
| `makeDefault` | `"Make default"` | Checkbox label in edit form |
| `deleteTitle` | `"Delete Favorite List"` | Delete modal heading |
| `deleteConfirm` | `"Are you sure you want to delete"` | Delete modal body text |
| `deleteWarning` | `"This action cannot be undone."` | Delete modal warning |
| `deleteButton` | `"Delete"` | Delete modal confirm button |
| `cancelButton` | `"Cancel"` | Cancel button in modals |
| `createTitle` | `"Create New List"` | Create modal heading |
| `createButton` | `"Create New List"` | Create button above list |
| `createPlaceholder` | `"Enter list name"` | Input placeholder in create modal |
| `setAsDefault` | `"Set as default favorite list"` | Checkbox label in create modal |
| `saveButton` | `"Save"` | Save button in create modal |
| `noLists` | `"No favorite lists"` | Empty state heading |
| `noListsDescription` | `"Start by creating a new list to save your items."` | Empty state description |
| `createFirstList` | `"Create your first list"` | Empty state create button |
| `loading` | `"Loading..."` | Loading state text |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  lastModified: "Last modified",
  items: "items",
  products: "products",
  clusters: "clusters",
  defaultBadge: "Default",
  editSave: "Save",
  editCancel: "Cancel",
  makeDefault: "Make default",
  deleteTitle: "Delete Favorite List",
  deleteConfirm: "Are you sure you want to delete",
  deleteWarning: "This action cannot be undone.",
  deleteButton: "Delete",
  cancelButton: "Cancel",
  createTitle: "Create New List",
  createButton: "Create New List",
  createPlaceholder: "Enter list name",
  setAsDefault: "Set as default favorite list",
  saveButton: "Save",
  noLists: "No favorite lists",
  noListsDescription: "Start by creating a new list to save your items.",
  createFirstList: "Create your first list",
  loading: "Loading...",
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Optimistic updates

The component updates local state immediately after user actions to provide instant feedback, without waiting for the API response:

- **Rename**: The list name and default status update in-place instantly. On API error, the full list is refetched from the server.
- **Delete**: The list is removed from the displayed array instantly. On API error, the full list is refetched.
- **Create**: After the API call succeeds, the component calls `onListChanged` (which triggers `refreshUser` on the parent page). The updated `props.user` flows back down, and the component re-reads lists from `user.favoriteLists.items` via the `useEffect` on `props.user`.
- **Set as default**: When a list is marked as default, the component clears the `isDefault` flag on the previously default list both in local state and via a separate API call before applying the new default.

### Modals

- **Create modal**: Opens from the "Create New List" button. Contains a name input and a "Set as default" checkbox. The save button is disabled when the name is empty. The modal closes on save or cancel.
- **Delete modal**: Opens when the delete button is clicked on a list card. Shows a confirmation prompt with the list name and a warning that the action is irreversible. Confirm triggers deletion; cancel closes the modal.

### Inline editing

Clicking the edit button on a list card replaces the list name and metadata with an inline form containing a name input, a "Make default" checkbox, and save/cancel buttons. Only one list can be edited at a time. Clicking the list card while in edit mode does not trigger `onListClick`.

### Sorting and limiting

When the `limit` prop is set, the component sorts all fetched lists by `updatedAt` descending (most recently modified first) and displays only the first N. Without `limit`, lists are displayed in the order returned by the API.

### Duplicate submission prevention

A `saving` flag prevents double-submissions during async create/edit/delete operations. Buttons are implicitly disabled while a mutation is in flight.

### Hydration safety

The component uses an `isMounted` state guard to prevent server/client hydration mismatches. Content renders only after the component has mounted on the client; a skeleton loader is shown during SSR.

### Loading state

While lists are being fetched, the component renders animated placeholder skeleton cards. The create button and empty state are hidden during loading.

### Empty state

When the user has no favorite lists, the component shows a centered empty state with a heart icon, a heading, a description, and (if `allowFavoriteListCreate` is `true`) a "Create your first list" button that opens the create modal.

### User type detection

The component determines whether the user is a B2B Contact or B2C Customer by checking for the presence of `contactId` on the user object. This determines which search field (`contactId` or `customerId`) is used when fetching and creating lists.

## SDK Services

The component uses `FavoriteListService` from `propeller-sdk-v2` for all CRUD operations.

### Service initialization

```ts


const service = new FavoriteListService(graphqlClient);
```

### Data source

The component reads lists directly from `props.user.favoriteLists.items` — it does **not** call `getFavoriteLists()` from the API. This means the user object (from AuthContext) must already contain populated favorite lists from the authentication response.

Lists are re-read whenever `props.user` changes. After mutations (create/edit/delete), the component calls `onListChanged` so the parent page can call `refreshUser()` to update the user object, which in turn updates the lists. The component does **not** refetch lists via a separate API call after mutations. It relies entirely on the `props.user` update cycle.

If you are building your own component, you can fetch lists from the API directly:

```ts


// For B2B Contact users
const searchInput: FavoriteListsSearchInput = {
  contactId: user.contactId,
};

// For B2C Customer users
const searchInput: FavoriteListsSearchInput = {
  customerId: user.customerId,
};

const response = await service.getFavoriteLists(searchInput);
const lists = response.items; // FavoriteList[]
```

### Creating a list

```ts
await service.createFavoriteList({
  name: 'My new list',
  isDefault: false,
  contactId: user.contactId, // or customerId for B2C
});
```

### Renaming / updating a list

```ts
await service.updateFavoriteList(listId, {
  name: 'Renamed list',
  isDefault: true,
});
```

### Deleting a list

```ts
await service.deleteFavoriteList(listId);
```

## GraphQL Queries and Mutations

The SDK service methods correspond to the following Propeller GraphQL operations.

### Query: list favorite lists

```graphql
query FavoriteLists($input: FavoriteListsSearchInput) {
  favoriteLists(input: $input) {
    itemsFound
    items {
      id
      name
      isDefault
      updatedAt
      products {
        itemsFound
        items {
          productId
        }
      }
      clusters {
        itemsFound
        items {
          clusterId
        }
      }
    }
  }
}
```

Variables:

```json
{
  "input": {
    "contactId": 123
  }
}
```

### Mutation: create a favorite list

```graphql
mutation CreateFavoriteList($input: FavoriteListCreateInput!) {
  favoriteListCreate(input: $input) {
    id
    name
    isDefault
  }
}
```

Variables:

```json
{
  "input": {
    "name": "Weekend project parts",
    "isDefault": false,
    "contactId": 123
  }
}
```

### Mutation: update a favorite list

```graphql
mutation UpdateFavoriteList($id: ID!, $input: FavoriteListUpdateInput!) {
  favoriteListUpdate(id: $id, input: $input) {
    id
    name
    isDefault
  }
}
```

Variables:

```json
{
  "id": "456",
  "input": {
    "name": "Renamed list",
    "isDefault": true
  }
}
```

### Mutation: delete a favorite list

```graphql
mutation DeleteFavoriteList($id: ID!) {
  favoriteListDelete(id: $id)
}
```

Variables:

```json
{
  "id": "456"
}
```

---

## Storefront SDK

URL: https://docs.propeller-commerce.com/reference/storefront-sdk

# Storefront SDK

Reference documentation for the Propeller Storefront SDK UI components. Each page covers a single component with two implementation paths:

- **React** tab: use the pre-built component with props, callbacks and labels
- **Build Your Own** tab: build the same functionality using SDK services directly in any framework (Vue, Angular, vanilla JS or your own React implementation)

For installation and getting started, see the [Storefront SDK guide](/frontend/storefront-sdk/ui-components).

## Components

| Category | Components | Description |
| --- | --- | --- |
| [Product Display](/reference/storefront-sdk/product-display) | 17 | Product cards, grids, pricing, media, specifications and bundles |
| [Cart and Checkout](/reference/storefront-sdk/cart-and-checkout) | 9 | Cart management, carriers, payment methods and action codes |
| [Navigation and Search](/reference/storefront-sdk/navigation-and-search) | 9 | Menus, breadcrumbs, search, filtering and pagination |
| [Authentication](/reference/storefront-sdk/authentication) | 7 | Login, registration, password recovery and account management |
| [Favorites](/reference/storefront-sdk/favorites) | 4 | Favorite lists and items |
| [Orders](/reference/storefront-sdk/orders) | 4 | Order history, details and totals |
| [Clusters](/reference/storefront-sdk/clusters) | 4 | Configurable products with options and variants |

## See also

- [Understanding the Storefront SDK](/frontend/storefront-sdk/understanding-the-storefront-sdk) for the three-layer architecture
- [Customization](/frontend/storefront-sdk/customization) for callbacks, pass-through properties and override patterns
- [B2B Capabilities](/frontend/storefront-sdk/b2b-capabilities) for portal modes and clusters

---

## Breadcrumbs

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/breadcrumbs

# Breadcrumbs

Renders a navigation breadcrumb trail from the category path returned by the Propeller SDK. Supports category, product, and cluster pages with localized names, configurable URL patterns, and accessible markup.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic -- Category Page

```tsx



<Breadcrumbs
  categoryPath={category.categoryPath}
  language="NL"
  configuration={config}
/>
```

Renders: **Home / Parent Category / Current Category**

### Product Page

```tsx
<Breadcrumbs
  categoryPath={product.categoryPath || []}
  language={language}
  showCurrent={true}
  configuration={config}
/>
```

Uses the product's `categoryPath` field, which contains the full ancestor chain from root to the product's primary category.

### Cluster Page

```tsx
<Breadcrumbs
  categoryPath={selectedProduct?.categoryPath || []}
  language={language}
  showCurrent={true}
  configuration={config}
/>
```

Pass the `categoryPath` from the cluster's selected product variant.

### Without Home Link

```tsx
<Breadcrumbs
  categoryPath={category.categoryPath}
  showHome={false}
  configuration={config}
/>
```

Omits the leading "Home" link. Only category items are rendered.

### Custom URL Builder

```tsx
<Breadcrumbs
  categoryPath={category.categoryPath}
  language="EN"
  getUrl={(cat, index) => `/shop/${cat.categoryId}`}
  configuration={config}
/>
```

Overrides the default URL generation for each category link.

### Custom Labels

```tsx
<Breadcrumbs
  categoryPath={category.categoryPath}
  labels={{ home: 'Start', separator: '>' }}
  configuration={config}
/>
```

Renders: **Start > Parent Category > Current Category**

### Hiding the Current Page

```tsx
<Breadcrumbs
  categoryPath={category.categoryPath}
  showCurrent={false}
  configuration={config}
/>
```

Drops the last item from the trail. Useful when the page heading already displays the current category name.

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom breadcrumbs component, use these patterns from the existing implementation:

### Basic -- Category Page

```ts


// The `categoryPath` is available on both category and product responses.
// No separate API call is needed.
const category = await CategoryService.getCategory({ categoryId: 42 });
const path = category.categoryPath; // Category[]

// Resolve localized values
function getLocalizedValue(items: LocalizedString[], lang: string): string {
  const match = items?.find(item => item.language === lang);
  return match?.value || items?.[0]?.value || '';
}

// Filter the root category
const filtered = path.filter(
  cat => cat.categoryId !== config.baseCategoryId
);

// Generate URLs
const breadcrumbs = filtered.map(cat => ({
  label: getLocalizedValue(cat.name, 'NL'),
  url: config.urls.getCategoryUrl(cat, 'NL'),
}));
```

### Product Page

```ts
// Product responses also include categoryPath
// No separate call needed — use product.categoryPath
const product = await ProductService.getProduct({ productId: 1001 });
const path = product.categoryPath; // Category[]

const filtered = path.filter(cat => cat.categoryId !== config.baseCategoryId);
const breadcrumbs = filtered.map(cat => ({
  label: getLocalizedValue(cat.name, language),
  url: config.urls.getCategoryUrl(cat, language),
}));
```

### Cluster Page

```ts
// Use categoryPath from the cluster's selected product variant
const path = selectedProduct?.categoryPath || [];
const filtered = path.filter(cat => cat.categoryId !== config.baseCategoryId);
const breadcrumbs = filtered.map(cat => ({
  label: getLocalizedValue(cat.name, language),
  url: config.urls.getCategoryUrl(cat, language),
}));
```

### Custom URL Builder

```ts
// Override URL generation per category
const breadcrumbs = filtered.map((cat, index) => ({
  label: getLocalizedValue(cat.name, 'EN'),
  url: `/shop/${cat.categoryId}`, // custom URL pattern
}));
```

### Without Home Link / Hiding the Current Page

```ts
// Control home and current page visibility:
const showHome = true;  // set to false to omit the home link
const showCurrent = true;  // set to false to drop the last item

let items = filtered;
if (!showCurrent) {
  items = items.slice(0, -1);
}

const breadcrumbs = [];
if (showHome) {
  breadcrumbs.push({ label: 'Home', url: '/' });
}
breadcrumbs.push(...items.map(cat => ({
  label: getLocalizedValue(cat.name, language),
  url: config.urls.getCategoryUrl(cat, language),
})));
```

### Structured Data (Optional)

For SEO, consider adding JSON-LD structured data alongside the visual breadcrumbs:

```ts
const structuredData = {
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": categoryPath.map((cat, i) => ({
    "@type": "ListItem",
    "position": i + 1,
    "name": getLocalizedValue(cat.name, language),
    "item": `https://example.com${config.urls.getCategoryUrl(cat, language)}`
  }))
};
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `categoryPath` | `Category[]` | *required* | Array of `Category` objects representing the path from root to the current item. Typically sourced from `category.categoryPath` or `product.categoryPath`. |
| `language` | `string` | `'NL'` | Language code used to resolve localized category names and slugs from the `name` and `slug` arrays on each `Category`. |
| `configuration` | `any` | `undefined` | App configuration object (from `@/data/config`). Used for `baseCategoryId` filtering and `urls.getCategoryUrl()` fallback URL generation. |

### Display

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showCurrent` | `boolean` | `true` | When `true`, the last item in the path is displayed as the current page. When `false`, the last item is omitted from the trail. |
| `showHome` | `boolean` | `true` | When `true`, a "Home" link is prepended as the first breadcrumb item. |
| `homeUrl` | `string` | `'/'` | URL for the Home link. |
| `className` | `string` | `''` | Extra CSS class applied to the root `<nav>` element. |

### Customization

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `getUrl` | `(category: Category, index: number) => string` | `undefined` | Custom URL builder for category links. Receives the `Category` object and its zero-based index. When omitted, falls back to `configuration.urls.getCategoryUrl()`. |
| `labels` | `Record<string, string>` | `undefined` | Override UI strings. Supported keys: `home` (default `'Home'`), `separator` (default `'/'`). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function Signature

```ts
// Breadcrumbs does not call SDK services directly.
// It receives pre-fetched data through the categoryPath prop.

function buildBreadcrumbs(
  categoryPath: Category[],
  language: string,
  config: { baseCategoryId: number; urls: { getCategoryUrl: (cat: Category, lang: string) => string } }
): Array<{ label: string; url: string }>;
```

### Options Table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `categoryPath` | `Category[]` | — | Array of `Category` objects from `category.categoryPath` or `product.categoryPath` |
| `language` | `string` | `'NL'` | Language code for resolving localized names and slugs |
| `baseCategoryId` | `number` | — | `configuration.baseCategoryId` — used to filter out the root category |
| `homeUrl` | `string` | `'/'` | URL for the Home link |

### UI-Only Props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showCurrent` — whether to display the last item as the current page
- `showHome` — whether to prepend a "Home" link
- `className` — extra CSS class for the root element
- `getUrl` — custom URL builder override
- `labels` — customizable UI strings (`home`, `separator`)

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Used in |
|-----|---------|---------|
| `home` | `'Home'` | Home link text |
| `separator` | `'/'` | Separator character between breadcrumb items |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  home: 'Home',
  separator: '/',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Navigation

- All breadcrumb items render as `<a>` links, including the current page item.
- The Home link points to `homeUrl` (default `'/'`).
- Category links are generated by `configuration.urls.getCategoryUrl(category, language)`, which respects the configured URL pattern (e.g., `page/id/slug` produces `/category/42/shoes`).
- When a custom `getUrl` function is provided, it takes full precedence over the configuration-based URL builder.

### Active Item

- The last item in the displayed path is considered the "current" item when `showCurrent` is `true`.
- When `showCurrent` is `false`, the last category in `categoryPath` is excluded entirely, and the new last item becomes a regular ancestor link.

### Separator

- A separator character is rendered between each breadcrumb item, including between the Home link and the first category.
- The default separator is `/`. Override it with `labels={{ separator: '>' }}` or any string.
- Separators are marked with `aria-hidden="true"` so screen readers skip them.

### Base Category Filtering

- When `configuration.baseCategoryId` is set, the component automatically filters out the root/base category from the trail. This prevents the site's top-level catalog node from appearing as a breadcrumb.

### Accessibility

- The root element is a `<nav>` with `aria-label="Breadcrumb"`.
- The breadcrumb items are rendered as an `<ol>` (ordered list), following WAI-ARIA breadcrumb guidelines.
- Separators use `aria-hidden="true"` to be invisible to assistive technology.

### Styling

- Uses Tailwind CSS utility classes: `flex flex-wrap items-center text-sm text-muted-foreground`.
- Links have a `hover:text-foreground transition-colors` hover effect.
- Separators are styled with `mx-2 select-none text-muted-foreground/40` for a subtle appearance.
- The component can be wrapped in a container with `className="propeller-breadcrumbs mb-6"` as used across the app pages.

## SDK Services

The Breadcrumbs component does not call SDK services directly. It receives pre-fetched data through the `categoryPath` prop.

### Required Category Fields

Each `Category` object in the `categoryPath` array must include:

| Field | Type | Purpose |
|-------|------|---------|
| `categoryId` | `number` | Used as the React list key and for URL generation. Also compared against `configuration.baseCategoryId` to filter out the root category. |
| `name` | `LocalizedString[]` | Array of `{ language: string, value: string }`. The component finds the entry matching the `language` prop, falling back to the first entry. |
| `slug` | `LocalizedString[]` | Array of `{ language: string, value: string }`. Used by `configuration.urls.getCategoryUrl()` to build the URL path segment. |

### Where categoryPath Comes From

The `categoryPath` field is returned by `CategoryService.getCategory()` and `ProductService.getProduct()` as part of their standard responses. It contains the ordered ancestor chain from the top-level category down to the current one.

```graphql
query {
  category(id: 42) {
    categoryId
    name { language value }
    slug { language value }
    categoryPath {
      categoryId
      name { language value }
      slug { language value }
    }
  }
}
```

For products, the path is available at `product.categoryPath`:

```graphql
query {
  product(id: 1001) {
    productId
    categoryPath {
      categoryId
      name { language value }
      slug { language value }
    }
  }
}
```

---

## CategoryDescription

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/category-description

# CategoryDescription

Renders a category's full description with optional "Read more" / "Read less" truncation. Resolves the correct language entry from the Propeller `Category` object and renders it as HTML.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic

```tsx


<CategoryDescription category={category} language="NL" />
```

### With truncation (default behavior)

```tsx
<CategoryDescription
  category={category}
  language="NL"
  collapsed={true}
  maxLength={200}
/>
```

The description is truncated at word boundaries after 200 characters and a **Read more** button appears. Clicking it expands to the full HTML content; clicking **Read less** collapses it again.

### Without truncation

```tsx
<CategoryDescription category={category} language="NL" collapsed={false} />
```

### Custom max length

```tsx
<CategoryDescription category={category} language="NL" maxLength={400} />
```

### Custom styling

```tsx
<CategoryDescription
  category={category}
  language="NL"
  className="border-b pb-4"
/>
```

### Combined with GridTitle and CategoryShortDescription on a category page

```tsx
<GridTitle title={categoryName} language="NL" />
<CategoryShortDescription category={category} language="NL" />
<CategoryDescription category={category} language="NL" maxLength={300} />
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom category description component:

1. Fetch the `Category` object with the `description` field included (see the GraphQL query below)
2. Resolve the correct language entry from `category.description` by matching the `language` field
3. Render the `value` as HTML (it may contain rich formatting from the Propeller backend)
4. If you need truncation, strip HTML tags first to measure true text length, then truncate at a word boundary to avoid cutting words in half
5. Use `dangerouslySetInnerHTML` (React) or `v-html` (Vue) to render the HTML content

```tsx
function SimpleDescription({ category, language }: { category: Category; language: string }) {
  const match = category.description?.find((d) => d.language === language);
  if (!match?.value) return null;

  return (
    <div
      className="prose max-w-none"
      dangerouslySetInnerHTML={{ __html: match.value }}
    />
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop       | Type       | Required | Default | Description                                                                                         |
| ---------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `category` | `Category` | No       | —       | Propeller `Category` object. The component reads the `description` array of `LocalizedString` items |
| `language` | `string`   | Yes      | —       | Language code (e.g. `"NL"`, `"EN"`) used to match the correct `LocalizedString` entry               |

### Truncation

| Prop        | Type      | Required | Default | Description                                                                                      |
| ----------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `collapsed` | `boolean` | No       | `true`  | When `true`, the description is truncated to `maxLength` characters with a toggle button         |
| `maxLength` | `number`  | No       | `200`   | Maximum number of plain-text characters before truncation kicks in. Only used when `collapsed` is `true` |

### Styling

| Prop        | Type     | Required | Default | Description                             |
| ----------- | -------- | -------- | ------- | --------------------------------------- |
| `className` | `string` | No       | —       | Extra CSS class applied to the root div |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function categoryDescription(category: Category, language: string): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `category` | `Category` | `undefined` | `category` prop |
| `language` | `string` | — | `language` prop |
| `collapsed` | `boolean` | `true` | `collapsed` prop |
| `maxLength` | `number` | `200` | `maxLength` prop |

### Category fields read

| Field         | SDK Type                   | Description                                                  |
| ------------- | -------------------------- | ------------------------------------------------------------ |
| `description` | `LocalizedString[]`        | Array of `{ language: string; value: string }` entries. Find the entry matching the `language` parameter and render its `value` as HTML |

### UI-only props

The following props only affect visual presentation and have no BYO equivalent: `className`.

</TabItem>
</Tabs>

---

## Behavior

### Language resolution

1. Reads `category.description` -- an array of `LocalizedString` objects (`{ language, value }`)
2. Finds the entry where `language` matches the `language` prop
3. Returns the `value` (HTML string), or an empty string if no match is found

### Truncation (collapsed: true, the default)

- Strips all HTML tags from the description to measure plain-text length
- If the plain-text length exceeds `maxLength`, truncates at the last word boundary before the limit and appends an ellipsis character
- The truncated view renders as plain text (no HTML); the expanded view renders the full HTML via `dangerouslySetInnerHTML`

### Empty state

When the description is empty (no `category` prop, no matching language entry, or an empty value), the component renders **nothing** -- no wrapper element is added to the DOM.

### Styling details

- Root element: `mb-6` bottom margin
- Full description: `prose prose-slate max-w-none text-muted-foreground`
- Toggle button: `text-sm font-medium text-primary hover:underline`

## SDK Services

This component does not call any SDK service directly. It expects a `Category` object to be passed via props (typically fetched by `CategoryService.getCategory()` or a direct GraphQL query).

### Category fields read

| Field         | SDK Type                   | Description                                                  |
| ------------- | -------------------------- | ------------------------------------------------------------ |
| `description` | `LocalizedString[]`        | Array of `{ language: string; value: string }` entries. The component finds the entry matching the `language` prop and renders its `value` as HTML |

## GraphQL Queries and Mutations

When fetching a category, include the `description` field to supply this component with data:

```graphql
query GetCategory($categoryId: Int!, $language: String) {
  category(id: $categoryId) {
    categoryId
    name(language: $language) {
      language
      value
    }
    description(language: $language) {
      language
      value
    }
  }
}
```

The returned `description` array is passed directly as `category.description`.

---

## CategoryShortDescription

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/category-short-description

# CategoryShortDescription

Renders a category's short description. Resolves the correct language entry from the Propeller `Category` object and renders it as HTML. Unlike `CategoryDescription`, this component has no truncation or toggle -- it always renders the full short description.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic

```tsx


<CategoryShortDescription category={category} language="NL" />
```

### Below a category title

```tsx
<GridTitle
  title={categoryName}
  language={process.env.NEXT_PUBLIC_DEFAULT_LANGUAGE || "NL"}
/>
<CategoryShortDescription
  category={category}
  language={process.env.NEXT_PUBLIC_DEFAULT_LANGUAGE || "NL"}
/>
```

### Custom styling

```tsx
<CategoryShortDescription
  category={category}
  language="NL"
  className="border-b pb-4"
/>
```

### Paired with CategoryDescription on a category page

```tsx
<CategoryShortDescription category={category} language="NL" />
<ProductGrid ... />
<CategoryDescription category={category} language="NL" maxLength={300} />
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom short description component:

1. Fetch the `Category` object with the `shortDescription` field included (see the GraphQL query below)
2. Resolve the correct language entry from `category.shortDescription` by matching the `language` field
3. Render the `value` as HTML (it may contain rich formatting from the Propeller backend)
4. Use `dangerouslySetInnerHTML` (React) or `v-html` (Vue) to render the HTML content

```tsx
function SimpleShortDescription({ category, language }: { category: Category; language: string }) {
  const match = category.shortDescription?.find((d) => d.language === language);
  if (!match?.value) return null;

  return (
    <div
      className="prose max-w-none"
      dangerouslySetInnerHTML={{ __html: match.value }}
    />
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop       | Type       | Required | Default | Description                                                                                              |
| ---------- | ---------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- |
| `category` | `Category` | No       | —       | Propeller `Category` object. The component reads the `shortDescription` array of `LocalizedString` items |
| `language` | `string`   | Yes      | —       | Language code (e.g. `"NL"`, `"EN"`) used to match the correct `LocalizedString` entry                    |

### Styling

| Prop        | Type     | Required | Default | Description                             |
| ----------- | -------- | -------- | ------- | --------------------------------------- |
| `className` | `string` | No       | —       | Extra CSS class applied to the root div |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function categoryShortDescription(category: Category, language: string): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `category` | `Category` | `undefined` | `category` prop |
| `language` | `string` | — | `language` prop |

### Category fields read

| Field              | SDK Type            | Description                                                                                                       |
| ------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `shortDescription` | `LocalizedString[]` | Array of `{ language: string; value: string }` entries. Find the entry matching the `language` parameter and render its `value` as HTML |

### UI-only props

The following props only affect visual presentation and have no BYO equivalent: `className`.

</TabItem>
</Tabs>

---

## Behavior

### Language resolution

1. Reads `category.shortDescription` -- an array of `LocalizedString` objects (`{ language, value }`)
2. Finds the entry where `language` matches the `language` prop
3. Returns the `value` (HTML string), or an empty string if no match is found

### Empty state

When the short description is empty (no `category` prop, no matching language entry, or an empty value), the component renders **nothing** -- no wrapper element is added to the DOM.

### Styling details

- Root element: `mb-6` bottom margin
- Description text: `prose prose-slate max-w-none text-muted-foreground`

### Comparison with CategoryDescription

| Feature            | CategoryShortDescription    | CategoryDescription                                |
| ------------------ | --------------------------- | -------------------------------------------------- |
| Source field        | `category.shortDescription` | `category.description`                             |
| Truncation         | No                          | Yes (configurable via `collapsed` and `maxLength`) |
| "Read more" toggle | No                          | Yes                                                |
| Use case           | Brief summary below title   | Full description with expand/collapse              |

## SDK Services

This component does not call any SDK service directly. It expects a `Category` object to be passed via props (typically fetched by `CategoryService.getCategory()` or a direct GraphQL query).

### Category fields read

| Field              | SDK Type            | Description                                                                                                       |
| ------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `shortDescription` | `LocalizedString[]` | Array of `{ language: string; value: string }` entries. The component finds the entry matching the `language` prop and renders its `value` as HTML |

## GraphQL Queries and Mutations

When fetching a category, include the `shortDescription` field to supply this component with data:

```graphql
query GetCategory($categoryId: Int!, $language: String) {
  category(id: $categoryId) {
    categoryId
    name(language: $language) {
      language
      value
    }
    shortDescription(language: $language) {
      language
      value
    }
  }
}
```

The returned `shortDescription` array is passed directly as `category.shortDescription`.

---

## GridFilters

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/grid-filters

# GridFilters

Sidebar filter panel for product grids. Renders collapsible accordion sections for attribute filters (checkboxes with counts) and a price range filter with dual slider and numeric inputs. Supports portal-mode visibility gating and external clear signals.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic attribute filters

```tsx


<GridFilters
  filters={attributeFilters}
  onFilterChange={(filter, value) => handleFilterChange(filter, value)}
/>
```

### With price range filter

```tsx
<GridFilters
  filters={attributeFilters}
  priceMin={0}
  priceMax={500}
  onFilterChange={handleFilterChange}
  onPriceChange={(min, max) => handlePriceChange(min, max)}
/>
```

### Full-featured sidebar with clear support

```tsx
const [clearSignal, setClearSignal] = useState(0);

<GridFilters
  filters={attributeFilters}
  priceMin={productsPriceMin}
  priceMax={productsPriceMax}
  language="NL"
  collapsed={true}
  clearSignal={clearSignal}
  onFilterChange={handleFilterChange}
  onPriceChange={handlePriceChange}
  onClearFilters={handleClearAll}
  getSelectedFilters={() => console.log("Filters changed")}
/>

{/* Trigger clear from toolbar */}
<GridToolbar onClearFilters={() => setClearSignal((s) => s + 1)} />
```

### Semi-closed portal mode (price filter hidden for guests)

```tsx
<GridFilters
  filters={attributeFilters}
  priceMin={0}
  priceMax={1000}
  portalMode="semi-closed"
  user={authenticatedUser}
  onFilterChange={handleFilterChange}
  onPriceChange={handlePriceChange}
/>
```

### Mobile layout (no sticky positioning)

```tsx
<GridFilters
  filters={attributeFilters}
  isMobile={true}
  collapsed={false}
  onFilterChange={handleFilterChange}
  className="px-4"
/>
```

### Integration with ProductGrid and GridToolbar

```tsx
const [textFilters, setTextFilters] = useState<Record<string, string[]>>({});
const [priceRange, setPriceRange] = useState({ min: 0, max: 9999 });
const [clearSignal, setClearSignal] = useState(0);

// Sidebar filters
<GridFilters
  filters={productsResponse?.filters || []}
  priceMin={productsResponse?.minPrice}
  priceMax={productsResponse?.maxPrice}
  clearSignal={clearSignal}
  onFilterChange={(filter, value) => {
    // Toggle value in textFilters state
  }}
  onPriceChange={(min, max) => setPriceRange({ min, max })}
  onClearFilters={() => {
    setTextFilters({});
    setPriceRange({ min: 0, max: 9999 });
  }}
/>

// Toolbar shows active filter badges
<GridToolbar
  activeTextFilters={textFilters}
  priceFilterMin={priceRange.min}
  priceFilterMax={priceRange.max}
  onFilterRemove={(name, value) => { /* remove from textFilters */ }}
  onPriceFilterRemove={() => setPriceRange({ min: 0, max: 9999 })}
  onClearFilters={() => setClearSignal((s) => s + 1)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom filter panel:

1. **Render attribute filters** -- Iterate over `AttributeFilter[]`. For each filter, display its `attributeDescription.descriptions[0].value` as the section title. Render `textFilters` as checkboxes.
2. **Filter out empty options** -- Only show options where `count > 0` or `countActive > 0`. Only show filters that have at least one valid option.
3. **Track selections** -- Maintain a `Record<string, string[]>` mapping filter names to selected values. Toggle values on checkbox change.
4. **Price range** -- Render min/max number inputs bounded by `priceMin`/`priceMax`. Optionally add a dual-thumb range slider. Apply price on blur or slider release, not on every keystroke.
5. **Accordion pattern** -- Wrap each filter section in a collapsible panel. Track expanded state per filter name. Auto-collapse filters with no active selections when the filter list refreshes.
6. **External clear** -- Watch a `clearSignal` counter prop. When it increments, reset all selections and price inputs to defaults.
7. **Portal-mode gating** -- In `semi-closed` mode, hide the price filter when no authenticated user is provided.

```ts


// Attribute filters come from the `filters` field in product query responses.
// Each AttributeFilter has:
//   attributeDescription.name — internal filter identifier
//   attributeDescription.descriptions[0].value — localized display title
//   textFilters[] — array of { value, count, countActive }

// Track selections as a map of filter name -> selected values
const selections: Record<string, string[]> = {};

function toggleFilter(filter: AttributeFilter, value: string) {
  const name = filter.attributeDescription?.name || '';
  if (!selections[name]) selections[name] = [];
  const idx = selections[name].indexOf(value);
  if (idx >= 0) {
    selections[name].splice(idx, 1);
  } else {
    selections[name].push(value);
  }
  // Re-fetch products with updated filter selections
}

// Price range: track min/max inputs bounded by priceMin/priceMax from the product query response
// Apply on blur or slider release, not on every keystroke
function applyPriceRange(min: number, max: number) {
  // Re-fetch products with price filter applied
}

// External clear: reset all selections and price inputs when clearSignal increments
function clearAll() {
  Object.keys(selections).forEach((key) => delete selections[key]);
  // Reset price inputs to defaults
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop             | Type                                                    | Description                                                                                    |
| ---------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `filters`        | `AttributeFilter[]`                                     | Attribute filter definitions from the product query response. Each entry is one filterable facet |
| `onFilterChange` | `(filter: AttributeFilter, value: string \| number) => void` | Called on every checkbox toggle. Receives the filter object and the toggled value              |

### Price Range

| Prop            | Type                                      | Default | Description                                                                        |
| --------------- | ----------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| `priceMin`      | `number`                                  | --      | Lower bound of the price range from the current product set. Omit to hide price filter |
| `priceMax`      | `number`                                  | --      | Upper bound of the price range                                                     |
| `onPriceChange` | `(min: number, max: number) => void`      | --      | Called when price range changes (on input blur or slider release)                   |

### Display & Layout

| Prop        | Type      | Default | Description                                                                       |
| ----------- | --------- | ------- | --------------------------------------------------------------------------------- |
| `collapsed` | `boolean` | `true`  | Whether filter accordions start collapsed. Set `false` to start expanded           |
| `isMobile`  | `boolean` | --      | Enables mobile layout (adds bottom padding, removes sticky positioning)            |
| `language`  | `string`  | `'NL'`  | Language code for filter labels                                                    |
| `className` | `string`  | --      | Extra CSS class applied to the root element                                        |

### Portal Mode & Auth

| Prop         | Type                          | Default  | Description                                                                     |
| ------------ | ----------------------------- | -------- | ------------------------------------------------------------------------------- |
| `portalMode` | `string`                      | `'open'` | `'open'` = show price filter for all. `'semi-closed'` = hide price for guests  |
| `user`       | `Contact \| Customer \| null` | --       | Authenticated user. Determines price filter visibility in `semi-closed` mode    |

### External Control

| Prop                | Type         | Default | Description                                                                              |
| ------------------- | ------------ | ------- | ---------------------------------------------------------------------------------------- |
| `clearSignal`       | `number`     | --      | Increment this counter to reset all selected filters and price inputs externally          |
| `onClearFilters`    | `() => void` | --      | Called when the internal "Clear all" action fires                                         |
| `getSelectedFilters`| `() => void` | --      | Notification callback fired after every filter or price change                            |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function gridFilters(
  filters: AttributeFilter[],
  onFilterChange: (filter: AttributeFilter, value: string | number) => void,
  options?: GridFiltersOptions,
): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `filters` | `AttributeFilter[]` | **required** | Attribute filter definitions from product query response |
| `priceMin` | `number` | `undefined` | Lower bound of the price range |
| `priceMax` | `number` | `undefined` | Upper bound of the price range |
| `language` | `string` | `'NL'` | Language code for filter labels |
| `portalMode` | `string` | `'open'` | Price filter visibility mode |
| `user` | `Contact \| Customer \| null` | `null` | Authenticated user for portal-mode gating |
| `clearSignal` | `number` | `undefined` | External clear trigger counter |

### Callbacks

| Callback | When it fires | What to implement |
|---|---|---|
| `onFilterChange` | On every checkbox toggle | Update filter selections and re-fetch products |
| `onPriceChange` | On price input blur or slider release | Update price range and re-fetch products |
| `onClearFilters` | When internal "Clear all" fires | Reset all filter state |
| `getSelectedFilters` | After every filter or price change | Notification hook for tracking changes |

### UI-only props

The following props are purely presentational and are not part of the SDK layer: `collapsed`, `isMobile`, `className`. These are the developer's responsibility to implement.

</TabItem>
</Tabs>

---

## Behavior

- **Accordion auto-management**: On initial load and when the `filters` prop changes, new filter sections default to collapsed (or expanded if `collapsed={false}`). Filters with no active selections auto-collapse on re-render.
- **Price range sync**: When `priceMin` or `priceMax` props change (e.g., after a product re-fetch with different filters), the internal min/max inputs update to match.
- **Dual input + slider**: The price filter provides both numeric inputs and a dual-thumb range slider. The slider applies the price immediately on change. The inputs apply on blur.
- **Min/max clamping**: The min input cannot exceed the current max, and the max input cannot go below the current min.
- **External clear signal**: Incrementing `clearSignal` resets all checkbox selections, price inputs, and accordion states. This is the mechanism for GridToolbar's "Clear All" button to reach GridFilters without direct coupling.
- **Filter option counts**: Each checkbox option displays the product count in parentheses. When `count` is 0 but `countActive` is greater than 0, `countActive` is displayed instead (handles the case where a selected filter shows its active match count).
- **Empty state**: When the `filters` array is empty, a "No filters available" message is displayed.
- **Sticky positioning**: By default the filter panel uses `sticky top-24` to stay visible while scrolling. This is disabled when `isMobile={true}`.
- **No API calls**: GridFilters is purely a UI component. All data fetching and query variable assembly is the parent's responsibility.

## SDK Services & Types

### Types Used

- **`AttributeFilter`** from `propeller-sdk-v2` -- Filter facet object returned by product queries. Key fields:
  - `attributeDescription.name` -- Internal filter identifier (used as key in selections map)
  - `attributeDescription.descriptions[0].value` -- Localized display title
  - `textFilters[]` -- Array of filter options, each with:
    - `value` -- The option label/value string
    - `count` -- Number of matching products
    - `countActive` -- Number of matching products when this option is already selected

- **`Contact`** / **`Customer`** from `propeller-sdk-v2` -- Used for portal-mode price filter gating

### GraphQL Response Shape

Attribute filters come from the `filters` field in product queries:

```graphql
query Products($categoryId: Int!, $language: String) {
  products(categoryId: $categoryId, language: $language) {
    items { ... }
    filters {
      attributeDescription {
        name
        descriptions {
          value
          language
        }
      }
      textFilters {
        value
        count
        countActive
      }
    }
    minPrice
    maxPrice
  }
}
```

The `filters` array maps directly to the `filters` prop, while `minPrice`/`maxPrice` map to `priceMin`/`priceMax`.

---

## GridPagination

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/grid-pagination

# GridPagination

Pagination control for product grids. Supports two display variants: a compact "Page X of Y" style and a full numbered-buttons style with ellipsis collapsing. Reads pagination data directly from a `ProductsResponse` object.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Compact pagination (default)

```tsx


<GridPagination
  products={productsResponse}
  onPageChange={(page) => setCurrentPage(page)}
/>
```

### Full numbered pagination

```tsx
<GridPagination
  products={productsResponse}
  onPageChange={handlePageChange}
  variant="full"
/>
```

### Full pagination with custom sibling count

```tsx
<GridPagination
  products={productsResponse}
  onPageChange={handlePageChange}
  variant="full"
  siblingCount={3}
/>
```

### With custom labels

```tsx
<GridPagination
  products={productsResponse}
  onPageChange={handlePageChange}
  labels={{
    previous: "Vorige",
    next: "Volgende",
    page: "Pagina",
    of: "van",
  }}
/>
```

### Placed above and below a product grid

```tsx
<GridPagination
  products={productsResponse}
  onPageChange={handlePageChange}
  variant="compact"
  className="mb-4"
/>

<ProductGrid /* ... */ />

<GridPagination
  products={productsResponse}
  onPageChange={handlePageChange}
  variant="full"
  className="mt-8"
/>
```

### Integration with ProductGrid

GridPagination does not fetch data itself. It reads pagination metadata from the same `ProductsResponse` that ProductGrid produces:

```tsx
const [page, setPage] = useState(1);

// ProductGrid populates productsResponse
<ProductGrid
  page={page}
  offset={24}
  onProductsLoaded={(response) => setProductsResponse(response)}
  /* ... */
/>

<GridPagination
  products={productsResponse}
  onPageChange={(newPage) => setPage(newPage)}
  variant="full"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom pagination component:

1. **Read pagination state** -- Extract `page` and `pages` from `ProductsResponse`.
2. **Compact variant** -- Render Previous/Next buttons with a "Page X of Y" label between them. Disable Previous on page 1 and Next on the last page.
3. **Full variant (ellipsis algorithm)** --
   - Always show page 1 and the last page.
   - Show `siblingCount` pages centered on the current page.
   - Insert ellipsis (`...`) spacers for gaps larger than 1.
   - When total pages fit within `siblingCount + 4` slots, skip ellipsis and show all pages.
4. **Emit page number** -- Call the parent's handler with the 1-based page number on click.
5. **Hide when unnecessary** -- Do not render pagination when `pages <= 1`.

```ts


// Extract pagination state from the products response
function getPaginationState(products: ProductsResponse) {
  const currentPage = products?.page || 1;
  const totalPages = products?.pages || 1;
  return { currentPage, totalPages };
}

// Compact variant: "Page X of Y" with Previous/Next buttons
function renderCompact(currentPage: number, totalPages: number, onPageChange: (page: number) => void) {
  // Previous button — disabled on page 1
  // "Page {currentPage} of {totalPages}" text
  // Next button — disabled on last page
}

// Full variant: numbered page buttons with ellipsis
function generatePageNumbers(currentPage: number, totalPages: number, siblingCount: number = 5): (number | '...')[] {
  // Always include page 1 and totalPages
  // Center siblingCount pages around currentPage
  // Insert '...' for gaps larger than 1
  // If totalPages <= siblingCount + 4, show all pages without ellipsis
  // Not documented in source — implement based on your setup
  return [];
}

// The `page` value emitted maps directly to the `page` variable in product queries
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop           | Type                              | Description                                                                 |
| -------------- | --------------------------------- | --------------------------------------------------------------------------- |
| `products`     | `ProductsResponse`                | Products response object. Reads `page` (current) and `pages` (total) from it |
| `onPageChange` | `(page: number) => void`          | Called when the user navigates to a different page. Receives the 1-based page number |

### Display

| Prop           | Type     | Default     | Description                                                                                   |
| -------------- | -------- | ----------- | --------------------------------------------------------------------------------------------- |
| `variant`      | `string` | `'compact'` | `'compact'` = Previous / "Page X of Y" / Next. `'full'` = numbered page buttons with ellipsis |
| `siblingCount` | `number` | `5`         | Number of visible page buttons around the current page in `'full'` variant                     |

### Customization

| Prop        | Type                     | Default | Description                                                  |
| ----------- | ------------------------ | ------- | ------------------------------------------------------------ |
| `labels`    | `Record<string, string>` | --      | Override built-in text (see Labels section below)            |
| `className` | `string`                 | --      | Extra CSS class applied to the root element                  |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function gridPagination(
  products: ProductsResponse,
  onPageChange: (page: number) => void,
  options?: GridPaginationOptions,
): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `products` | `ProductsResponse` | **required** | Products response object with `page` and `pages` fields |
| `variant` | `string` | `'compact'` | Pagination display variant |
| `siblingCount` | `number` | `5` | Number of visible page buttons around the current page |

### Callbacks

| Callback | When it fires | What to implement |
|---|---|---|
| `onPageChange` | When the user navigates to a different page | Re-fetch products with the new 1-based page number |

### UI-only props

The following props are purely presentational and are not part of the SDK layer: `labels`, `className`. These are the developer's responsibility to implement.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

Override any of these via the `labels` prop:

| Key        | Default      | Used For                          |
| ---------- | ------------ | --------------------------------- |
| `previous` | `'Previous'` | Previous page button text         |
| `next`     | `'Next'`     | Next page button text             |
| `page`     | `'Page'`     | Compact variant label prefix      |
| `of`       | `'of'`       | Compact variant separator ("of")  |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  previous: 'Previous',
  next: 'Next',
  page: 'Page',
  of: 'of',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Auto-hides on single page**: When `pages` is 1 or less, the component renders nothing.
- **Previous/Next button disabling**: Previous is disabled on page 1. Next is disabled on the last page. Both use `disabled` attribute with reduced opacity styling.
- **Compact variant**: Renders three elements in a row: Previous button, "Page X of Y" text, Next button.
- **Full variant page algorithm**: Page 1 and the last page are always visible. A window of `siblingCount` pages (default 5) is centered on the current page. Gaps are collapsed with ellipsis spacers. When the total page count is small enough (`<= siblingCount + 4`), all pages are shown without ellipsis.
- **Active page highlighting**: In full variant, the current page button receives primary-colored styling (`bg-primary text-white`), while other page buttons use neutral styling.
- **1-based page numbers**: All page numbers are 1-based, matching the Propeller API convention.
- **Responsive**: The full variant uses `flex-wrap` to handle large page counts on small screens.
- **No API calls**: GridPagination is purely a UI control. The parent is responsible for re-fetching products with the new page number.

## SDK Services & Types

### Types Used

- **`ProductsResponse`** from `propeller-sdk-v2` -- The component reads two fields:
  - `products.page` -- Current page number (1-based)
  - `products.pages` -- Total number of pages

### Corresponding GraphQL Query Variables

The `page` value emitted by `onPageChange` maps directly to the `page` variable in product queries:

```graphql
query Products($page: Int, $offset: Int) {
  products(page: $page, offset: $offset) {
    page
    pages
    itemsFound
    items { ... }
  }
}
```

---

## GridTitle

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/grid-title

# GridTitle

Renders the main heading for product grid pages -- category listings, search results, brand pages, or any context where a prominent title is needed above a product grid.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic category page

```tsx


<GridTitle title="Outdoor & Travel" language="NL" />
```

### Dynamic category name from the SDK

```tsx
<GridTitle
  title={category.name[0]?.value ?? "Products"}
  language={process.env.NEXT_PUBLIC_DEFAULT_LANGUAGE || "NL"}
/>
```

### Search results page

```tsx
<GridTitle title={`Search results for "${searchTerm}"`} language="NL" />
```

### As an h2 (page already has an h1)

Use `headingLevel="h2"` when the grid is embedded inside a page that already owns the h1, such as a brand landing page or a CMS page with its own title.

```tsx
<GridTitle title="Related products" language="NL" headingLevel="h2" />
```

### With extra styling

```tsx
<GridTitle
  title="Brand: Fellowes"
  language="NL"
  className="border-b pb-4"
/>
```

### Combined with other grid components

```tsx
<div>
  <GridTitle title={categoryName} language="NL" />
  <CategoryDescription description={categoryDescription} language="NL" />
  <GridToolbar ... />
  <ProductGrid ... />
  <GridPagination ... />
</div>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

GridTitle is intentionally minimal. To extend or replace it:

1. **Add a product count badge** -- Accept an `itemCount` prop and render it next to the title inside the existing `flex items-baseline gap-3` wrapper:
   ```tsx
   <span className="text-sm text-gray-500">{itemCount} products</span>
   ```

2. **Support additional heading levels** -- Replace the two `Show` blocks with a dynamic element. In React you can use `createElement`:
   ```tsx
   const Tag = (headingLevel || "h1") as keyof JSX.IntrinsicElements;
   return <Tag className="text-3xl sm:text-4xl font-bold tracking-tight">{title}</Tag>;
   ```

3. **Add breadcrumbs** -- Render a breadcrumb trail above the heading inside the root `<div>`, using the category hierarchy from `CategoryService`.

4. **Integrate a subtitle or description** -- Add an optional `subtitle` prop and render it below the heading. For category descriptions, consider using the separate `CategoryDescription` component instead to keep concerns separated.

Keep the component stateless and free of data-fetching logic. Let the parent page handle SDK calls and pass resolved strings as props.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Content

| Prop       | Type     | Required | Default | Description                                                              |
| ---------- | -------- | -------- | ------- | ------------------------------------------------------------------------ |
| `title`    | `string` | Yes      | --      | The heading text. Typically a category name, search term, or brand name. |
| `language` | `string` | Yes      | --      | Language code for the content (e.g. `'NL'`, `'EN'`).                    |

### Appearance

| Prop           | Type     | Required | Default | Description                                                                 |
| -------------- | -------- | -------- | ------- | --------------------------------------------------------------------------- |
| `headingLevel` | `string` | No       | `'h1'`  | HTML heading level. Set to `'h2'` when the page already has its own `h1`.   |
| `className`    | `string` | No       | --      | Additional CSS class(es) applied to the root `<div>` wrapper.               |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function gridTitle(options: GridTitleOptions): void
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `title` | `string` | (required) | `title` prop |
| `language` | `string` | (required) | `language` prop |
| `headingLevel` | `string` | `'h1'` | `headingLevel` prop |

### UI-only props

The following props are UI-specific and do not apply when building your own:

- `className` -- CSS class on root element

</TabItem>
</Tabs>

---

## Behavior

- Renders an `<h1>` tag by default. When `headingLevel` is set to `'h2'`, it renders an `<h2>` instead. All other `headingLevel` values fall through to the `h1` default.
- The heading uses responsive font sizing: `text-3xl` on small screens, `text-4xl` on `sm:` breakpoint and above, with `font-bold` and `tracking-tight`.
- The root element applies `mb-8` bottom margin for spacing above the next grid section.
- Fully stateless -- no internal state, no side effects, no API calls. It re-renders only when props change.

## SDK Services

GridTitle is a **presentational component** -- it does not call any SDK service directly. The parent page is responsible for fetching category data and passing the title string.

When used on a category page, the title typically comes from a `Category` object returned by `CategoryService.getCategory()`. The relevant field is:

| Category field | Type                          | Usage                                         |
| -------------- | ----------------------------- | --------------------------------------------- |
| `name`         | `LocalizedString[]` (array)   | `category.name[0]?.value` provides the title. |

For search pages, the title is constructed from the user's search query string rather than an SDK field.

---

## GridToolbar

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/grid-toolbar

# GridToolbar

Toolbar for product grids that provides sort controls, per-page size selector, grid/list view toggle, result count display, and removable filter badges. Designed to sit above a ProductGrid and coordinate sorting, pagination size, view mode, and active filter visualization.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic with sort and page size callbacks

```tsx


<GridToolbar
  itemsFound={594}
  onSortChange={(field, order) => console.log(field, order)}
  onOffsetChange={(size) => console.log("Page size:", size)}
/>
```

### With custom sort options and default sort

```tsx
<GridToolbar
  sortOptions={["NAME", "PRICE", "CREATED_AT"]}
  defaultSort={[{ field: "PRICE", order: "DESC" }]}
  onSortChange={handleSortChange}
  onOffsetChange={handleOffsetChange}
  itemsFound={totalProducts}
/>
```

### Full toolbar with view toggle, pagination range, and active filters

```tsx
<GridToolbar
  sortOptions={["CATEGORY_ORDER", "NAME", "PRICE"]}
  defaultSort={currentSort}
  viewMode={viewMode}
  offset={[12, 24, 48, 96]}
  defaultOffset={24}
  itemsFound={totalProducts}
  page={currentPage}
  pageSize={24}
  pageItemCount={productsOnThisPage}
  activeTextFilters={{ color: ["Red", "Blue"], brand: ["Nike"] }}
  priceFilterMin={10}
  priceFilterMax={200}
  onSortChange={handleSort}
  onOffsetChange={handlePageSize}
  onViewChange={handleViewChange}
  onFilterRemove={handleFilterRemove}
  onPriceFilterRemove={handlePriceFilterRemove}
  onClearFilters={handleClearAll}
  labels={{ products: " items", clearAll: "Reset filters" }}
  className="mb-6"
/>
```

### Semi-closed portal mode (price sorting disabled for guests)

```tsx
<GridToolbar
  portalMode="semi-closed"
  user={authenticatedUser}
  onSortChange={handleSort}
  onOffsetChange={handlePageSize}
  itemsFound={120}
/>
```

### Minimal with custom page sizes only

```tsx
<GridToolbar
  offset={[10, 25, 50, 100]}
  defaultOffset={25}
  onOffsetChange={handlePageSize}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

GridToolbar is a pure presentational + local-state component. To build a custom version:

1. **Sort controls** -- Read `Enums.ProductSortField` keys for available sort fields. Emit `{ field, order }` on change.
2. **Page size selector** -- Render options from an array of numbers. Emit the selected value on change.
3. **View toggle** -- Track `'grid'` / `'list'` state and toggle on click.
4. **Filter badges** -- Flatten `Record<string, string[]>` into individual badge items. Each badge needs the filter name + value so the parent can remove it.
5. **Price badge** -- Render when `priceFilterMin` or `priceFilterMax` is defined. Display as a formatted range.
6. **Sync from props** -- Watch `defaultSort`, `defaultOffset`, and `viewMode` for external state changes (e.g., URL-driven sort).

### Integration with ProductGrid

GridToolbar does not make API calls itself. It emits user intent via callbacks (`onSortChange`, `onOffsetChange`, etc.) that the parent page uses to update ProductGrid query variables:

```ts
// pseudo-code: maintain sort and page size as local state
let sort = [{ field: "CATEGORY_ORDER", order: "ASC" }];
let pageSize = 12;

// When the user changes sort via the toolbar:
function onSortChange(field: string, order: string) {
  sort = [{ field, order }];
  // re-fetch products with updated sort
}

// When the user changes page size via the toolbar:
function onOffsetChange(size: number) {
  pageSize = size;
  // re-fetch products with updated offset
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data Display

| Prop            | Type     | Default | Description                                                                                |
| --------------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `itemsFound`    | `number` | --      | Total products found. Displays as a count on the left side. Pass 0 or omit to hide         |
| `page`          | `number` | --      | Current page number (1-based). Used with `pageSize` and `itemsFound` for range display     |
| `pageSize`      | `number` | `12`    | Items per page. Used with `page` and `itemsFound` to compute the displayed range           |
| `pageItemCount` | `number` | --      | Actual items on the current page. Overrides `pageSize` for the range end when provided     |

### Sorting

| Prop          | Type                                          | Default                                        | Description                                                                            |
| ------------- | --------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------- |
| `sortOptions` | `string[]`                                    | All `ProductSortField` values                  | Sort field keys to show in the dropdown (e.g. `['NAME', 'PRICE']`)                     |
| `defaultSort` | `{ field: string; order: string }[]`          | `[{ field: 'CATEGORY_ORDER', order: 'ASC' }]` | Active sort. First element is used                                                      |
| `onSortChange`| `(field: string, order: string) => void`      | --                                             | Called when sort field or direction changes. Receives new field key and `'ASC'`/`'DESC'` |

### Page Size

| Prop             | Type                         | Default      | Description                                            |
| ---------------- | ---------------------------- | ------------ | ------------------------------------------------------ |
| `offset`         | `number[]`                   | `[12, 24, 48]` | Available page-size options in the per-page dropdown  |
| `defaultOffset`  | `number`                     | `12`         | Initially selected page size                            |
| `onOffsetChange` | `(offset: number) => void`   | --           | Called when the user selects a different per-page value |

### View Mode

| Prop           | Type                           | Default  | Description                                                        |
| -------------- | ------------------------------ | -------- | ------------------------------------------------------------------ |
| `viewMode`     | `string`                       | `'grid'` | Layout mode: `'grid'` or `'list'`. Controls which toggle icon shows |
| `onViewChange` | `(mode: string) => void`       | --       | Called when the view toggle is clicked. Receives `'grid'` or `'list'` |

### Active Filter Badges

| Prop                 | Type                                           | Default | Description                                                         |
| -------------------- | ---------------------------------------------- | ------- | ------------------------------------------------------------------- |
| `activeTextFilters`  | `Record<string, string[]>`                     | --      | Currently active attribute filters. Key = attribute, value = selections. Renders removable badges |
| `priceFilterMin`     | `number`                                       | --      | Active price filter lower bound. Renders a price badge when defined |
| `priceFilterMax`     | `number`                                       | --      | Active price filter upper bound                                     |
| `onFilterRemove`     | `(filterName: string, value: string) => void`  | --      | Called when an attribute filter badge X is clicked                   |
| `onPriceFilterRemove`| `() => void`                                   | --      | Called when the price filter badge X is clicked                     |
| `onClearFilters`     | `() => void`                                   | --      | Called when "Clear All" is clicked                                  |

### Portal Mode & Auth

| Prop         | Type                            | Default  | Description                                                              |
| ------------ | ------------------------------- | -------- | ------------------------------------------------------------------------ |
| `portalMode` | `string`                        | `'open'` | `'open'` = price sort available for all. `'semi-closed'` = disabled for guests |
| `user`       | `Contact \| Customer \| null`   | --       | Authenticated user. When null in `semi-closed` mode, PRICE sort is disabled |

### Customization

| Prop       | Type                     | Default | Description                                                        |
| ---------- | ------------------------ | ------- | ------------------------------------------------------------------ |
| `labels`   | `Record<string, string>` | --      | Label overrides for any built-in text (see Label Keys below)       |
| `className`| `string`                 | --      | Extra CSS class applied to the root element                        |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function gridToolbar(options: GridToolbarOptions): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `sortOptions` | `string[]` | All `ProductSortField` values | Sort field keys |
| `defaultSort` | `{ field: string; order: string }[]` | `[{ field: 'CATEGORY_ORDER', order: 'ASC' }]` | Active sort state |
| `offset` | `number[]` | `[12, 24, 48]` | Page size options |
| `defaultOffset` | `number` | `12` | Selected page size |
| `viewMode` | `string` | `'grid'` | Layout mode (`'grid'` or `'list'`) |
| `portalMode` | `string` | `'open'` | Portal access level |
| `user` | `Contact \| Customer \| null` | `null` | Authenticated user for portal gating |

### Callbacks

| Callback | Signature | Description |
|---|---|---|
| `onSortChange` | `(field: string, order: string) => void` | Sort field or direction changed |
| `onOffsetChange` | `(offset: number) => void` | Page size changed |
| `onViewChange` | `(mode: string) => void` | View toggle clicked |
| `onFilterRemove` | `(filterName: string, value: string) => void` | Attribute filter badge removed |
| `onPriceFilterRemove` | `() => void` | Price filter badge removed |
| `onClearFilters` | `() => void` | Clear all filters clicked |

### UI-only props

The following props control display only and have no SDK equivalent: `itemsFound`, `page`, `pageSize`, `pageItemCount`, `activeTextFilters`, `priceFilterMin`, `priceFilterMax`, `labels`, `className`. Pass these to your custom UI as needed.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

Override any of these via the `labels` prop:

| Key                  | Default              | Used For                    |
| -------------------- | -------------------- | --------------------------- |
| `CATEGORY_ORDER`     | `'Default Sorting'`  | Sort dropdown option        |
| `NAME`               | `'Name'`             | Sort dropdown option        |
| `PRICE`              | `'Price'`            | Sort dropdown option + badge |
| `SKU`                | `'SKU'`              | Sort dropdown option        |
| `SUPPLIER_CODE`      | `'Supplier Code'`    | Sort dropdown option        |
| `CREATED_AT`         | `'Created Date'`     | Sort dropdown option        |
| `LAST_MODIFIED_AT`   | `'Last Modified Date'`| Sort dropdown option       |
| `RELEVANCE`          | `'Relevance'`        | Sort dropdown option        |
| `PRIORITY`           | `'Priority'`         | Sort dropdown option        |
| `ASC`                | `'Low to High'`      | Sort direction dropdown     |
| `DESC`               | `'High to Low'`      | Sort direction dropdown     |
| `clearAll`           | `'Clear All'`        | Clear filters button        |
| `products`           | `' Products'`        | Result count suffix         |
| `from`               | `'from'`             | Range indicator             |
| `results`            | `'results'`          | Range indicator             |
| `perPage`            | `' per page'`        | Page size dropdown suffix   |
| `price`              | `'Price'`            | Price filter badge prefix   |
| `switchToList`       | `'Switch to list view'`| View toggle tooltip       |
| `switchToGrid`       | `'Switch to grid view'`| View toggle tooltip       |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  CATEGORY_ORDER: 'Default Sorting',
  NAME: 'Name',
  PRICE: 'Price',
  SKU: 'SKU',
  SUPPLIER_CODE: 'Supplier Code',
  CREATED_AT: 'Created Date',
  LAST_MODIFIED_AT: 'Last Modified Date',
  RELEVANCE: 'Relevance',
  PRIORITY: 'Priority',
  ASC: 'Low to High',
  DESC: 'High to Low',
  clearAll: 'Clear All',
  products: ' Products',
  from: 'from',
  results: 'results',
  perPage: ' per page',
  price: 'Price',
  switchToList: 'Switch to list view',
  switchToGrid: 'Switch to grid view',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Controlled externally via props**: `defaultSort`, `defaultOffset`, and `viewMode` sync internal state when they change, allowing URL-driven or parent-driven updates.
- **Sort field + direction are separate dropdowns**: The sort field and sort direction (ASC/DESC) are independent selects. Both emit through the same `onSortChange` callback.
- **Price sort gating**: In `semi-closed` portal mode, the PRICE sort option is rendered with `disabled` when no `user` is provided.
- **Filter badges auto-render**: When `activeTextFilters` or `priceFilterMin`/`priceFilterMax` are provided, the badges bar appears automatically below the toolbar controls.
- **Clear All**: Appears at the start of the badge bar. Calls `onClearFilters` to let the parent reset all filter state.
- **View toggle icon swap**: Shows a list icon when in grid mode (click to switch to list) and a grid icon when in list mode (click to switch to grid).
- **Responsive layout**: Controls stack vertically on small screens (`flex-col`) and align horizontally on `sm:` and above.
- **No API calls**: GridToolbar is purely a UI controller. All data fetching responsibility remains with the parent or sibling ProductGrid.

## SDK Services & Types

### Enums Used

- **`Enums.ProductSortField`** -- Provides sort field constants: `CATEGORY_ORDER`, `NAME`, `PRICE`, `SKU`, `SUPPLIER_CODE`, `CREATED_AT`, `LAST_MODIFIED_AT`, `RELEVANCE`, `PRIORITY`
- **`Enums.SortOrder`** -- Sort direction constants: `ASC`, `DESC`

### User Types

- **`Contact`** / **`Customer`** from `propeller-sdk-v2` -- Used for the `user` prop to determine portal access level

---

## Menu

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/menu

# Menu

A navigation component that renders a category hierarchy fetched from the Propeller GraphQL API. It supports two layout styles -- **dropdown-vertical** (nested flyout columns on hover) and **jumbotron** (full-width mega-menu panel) -- plus a mobile accordion view that shows automatically on smaller screens.

The component handles its own data fetching, caching, and localization internally. User interactions are delegated to the parent via the `onMenuItemClick` callback for SPA-style routing.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic dropdown menu in a header

```tsx





function Header() {
  const router = useRouter();

  return (
    <Menu
      graphqlClient={graphqlClient}
      categoryId={17}
      language="NL"
      configuration={config}
      onMenuItemClick={(category) => {
        router.push(config.urls.getCategoryUrl(category, 'NL'));
      }}
    />
  );
}
```

### Jumbotron / mega-menu style

```tsx
<Menu
  graphqlClient={graphqlClient}
  categoryId={17}
  language="NL"
  menuStyle="jumbotron"
  configuration={config}
  onMenuItemClick={(category) =>
    router.push(config.urls.getCategoryUrl(category, 'NL'))
  }
/>
```

### With authenticated user (enables user-specific cache buckets)

```tsx
<Menu
  graphqlClient={graphqlClient}
  categoryId={17}
  language="NL"
  user={authState.user}
  configuration={config}
  onMenuItemClick={(category) => {
    router.push(config.urls.getCategoryUrl(category, 'NL'));
  }}
/>
```

### Always-mounted pattern (prevents re-fetch on toggle)

The recommended pattern keeps the menu always mounted in the DOM and toggles visibility with CSS. This avoids re-fetching the category tree every time the menu opens.

```tsx
const [showMenu, setShowMenu] = useState(false);

<div
  ref={menuRef}
  onMouseLeave={() => setShowMenu(false)}
>
  <button onMouseEnter={() => setShowMenu(true)}>
    Browse Categories
  </button>

  <div className={showMenu
    ? "visible opacity-100"
    : "invisible opacity-0 pointer-events-none h-0 overflow-hidden"
  }>
    <Menu
      graphqlClient={graphqlClient}
      categoryId={17}
      language={language}
      user={user}
      configuration={config}
      onMenuItemClick={(category) => {
        setShowMenu(false);
        router.push(config.urls.getCategoryUrl(category, language));
      }}
    />
  </div>
</div>
```

### Custom labels (Dutch localization)

```tsx
<Menu
  graphqlClient={graphqlClient}
  categoryId={17}
  language="NL"
  configuration={config}
  labels={{
    loading: 'Menu laden...',
    error: 'Menu kon niet geladen worden',
    empty: 'Geen categorieën gevonden',
  }}
  onMenuItemClick={(category) =>
    router.push(config.urls.getCategoryUrl(category, 'NL'))
  }
/>
```

### Deeper hierarchy with custom styling

```tsx
<Menu
  graphqlClient={graphqlClient}
  categoryId={17}
  language="EN"
  depth={4}
  menuClass="border rounded-lg bg-white shadow-sm"
  className="w-72"
  configuration={config}
  onMenuItemClick={(category) =>
    router.push(config.urls.getCategoryUrl(category, 'EN'))
  }
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need full control over the menu rendering, you can fetch the category tree yourself and build a custom UI.

### Recursive query construction and data fetching

```ts


interface CategoryTree extends Category {
  categories?: CategoryTree[];
}

function buildCategoriesQuery(depth: number): string {
  if (depth === 0) return '';
  return `
    categories {
      categoryId
      name(language: $language) { value language }
      slug(language: $language) { value }
      ${buildCategoriesQuery(depth - 1)}
    }
  `;
}

async function fetchCategoryTree(
  client: GraphQLClient,
  categoryId: number,
  language: string,
  depth: number = 3
): Promise<CategoryTree | null> {
  const query = `
    query Menu($categoryId: Float, $language: String) {
      category(categoryId: $categoryId) {
        categoryId
        name(language: $language) { value language }
        slug(language: $language) { value }
        ${buildCategoriesQuery(depth)}
      }
    }
  `;

  const response = await client.execute({
    query,
    variables: { categoryId, language },
  });

  return response?.data?.category || null;
}

// Helper: resolve localised category name
function getCategoryName(cat: Category, language: string): string {
  const match = cat.name?.find((n: LocalizedString) => n.language === language);
  return match?.value || cat.name?.[0]?.value || '';
}

// Helper: resolve localised category slug
function getCategorySlug(cat: Category, language: string): string {
  const match = cat.slug?.find((s: LocalizedString) => s.language === language);
  return match?.value || cat.slug?.[0]?.value || '';
}

// Fetch the tree
const root = await fetchCategoryTree(graphqlClient, 17, 'NL', 3);
// root.categories -> L1 categories
// root.categories[0].categories -> L2 categories, etc.
```

### Caching pattern

To avoid re-fetching on every page load, cache the result in `localStorage`:

1. Build a cache key that includes the `categoryId`, `language`, and user identity (e.g., `propeller_menu_17_NL` for anonymous, `propeller_menu_17_NL_c123` for Contact with id 123).
2. Before fetching, check `localStorage` for a cached entry. Parse the stored JSON and compare the timestamp against a 12-hour TTL.
3. If the cache is valid, use it directly. Otherwise, fetch from the API and store the result with a `Date.now()` timestamp.
4. Wrap `localStorage.setItem` in a try/catch for quota safety.

### Rendering

Your UI should render the fetched `CategoryTree` as a nested navigation. For each category, use `getCategoryName()` for the display label and build a URL from `categoryId` and `getCategorySlug()`. Recursively render `cat.categories` for subcategories.

Key points when building your own:

- **Do not use `CategoryService.getCategory()`** for menu data -- it returns a flat category without nested children.
- Use `graphqlClient.execute()` with the recursive query pattern shown above.
- The `language` variable controls which translations are returned for `name` and `slug` fields.
- Authenticated users may see different categories, so include user identity in your cache key if you implement caching.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data & fetching

| Prop | Type | Default | Description |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | **required** | Initialized Propeller SDK GraphQL client used to fetch category data |
| `categoryId` | `number` | **required** | Root category ID -- the top of the menu tree |
| `language` | `string` | **required** | Language code for localized category names and slugs (e.g. `'NL'`, `'EN'`) |
| `depth` | `number` | `3` | Maximum nesting depth of the category hierarchy |
| `user` | `Contact \| Customer \| null` | `null` | Authenticated user. When the user changes (login/logout), the cache key changes and the menu re-fetches |
| `configuration` | `any` | `undefined` | App configuration object (from `@/data/config`). Must include `urls.getCategoryUrl(category, language)` for URL generation |

### Appearance

| Prop | Type | Default | Description |
|---|---|---|---|
| `menuStyle` | `string` | `'dropdown-vertical'` | Layout variant: `'dropdown-vertical'` or `'jumbotron'` |
| `menuClass` | `string` | -- | CSS class applied to the inner `<nav>` element |
| `className` | `string` | -- | CSS class applied to the root `<div>` wrapper |
| `menuLinkFormat` | `string` | -- | URL pattern with `{categoryId}` and `{slug}` placeholders (used as fallback if `configuration` is not provided) |

### Callbacks & labels

| Prop | Type | Default | Description |
|---|---|---|---|
| `onMenuItemClick` | `(category: Category) => void` | **required** | Called when a menu link is clicked. The default `<a>` navigation is prevented so the parent controls routing |
| `labels` | `Record<string, string>` | -- | Override UI strings. Keys: `loading`, `error`, `empty` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchCategoryTree(
  client: GraphQLClient,
  categoryId: number,
  language: string,
  depth?: number
): Promise<CategoryTree | null>
```

Types: `GraphQLClient`, `Category`, `LocalizedString` from `propeller-sdk-v2`.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `client` | `GraphQLClient` | required | `graphqlClient` prop |
| `categoryId` | `number` | required | `categoryId` prop |
| `language` | `string` | required | `language` prop |
| `depth` | `number` | `3` | `depth` prop |

When a `user` is present, the component also passes `contactId` (for Contact users) or `customerId` (for Customer users) in the query variables so the API can apply user-specific category visibility rules.

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onMenuItemClick` | A menu link is clicked | Navigate to the category URL using your framework's router (e.g., `router.push(url)`) |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `menuStyle` — layout variant (`'dropdown-vertical'` or `'jumbotron'`)
- `menuClass` — CSS class on the inner `<nav>`
- `className` — CSS class on the root wrapper
- `menuLinkFormat` — URL pattern fallback
- `labels` — UI strings (`loading`, `error`, `empty`)
- `configuration` — app config for URL generation

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Shown when |
|---|---|---|
| `loading` | `'Loading menu...'` | Categories are being fetched |
| `error` | `'Failed to load menu'` | The GraphQL request failed |
| `empty` | `'No categories found'` | The root category has no visible subcategories |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  loading: 'Loading menu...',
  error: 'Failed to load menu',
  empty: 'No categories found',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Layout styles

### `dropdown-vertical` (default)

A vertical list of top-level categories. On hover, subcategories appear as flyout columns to the right, up to 3 levels deep. Desktop only -- on mobile the component renders an accordion instead.

```
+-----------------+
| Computers       | -> +-----------------+
| Peripherals     |    | Keyboards       | -> +-----------------+
| Networking      |    | Mice            |    | Wireless        |
| ...             |    | Monitors        |    | Wired           |
+-----------------+    | ...             |    | Ergonomic       |
                       +-----------------+    +-----------------+
```

### `jumbotron`

Top-level categories render as horizontal tabs. The hovered tab reveals a full-width panel with subcategories in a responsive grid (2-4 columns). Level 3 items appear as lists beneath each level 2 heading.

```
[ Computers ] [ Peripherals ] [ Networking ] ...
+------------------------------------------------------+
|  Keyboards        Mice            Monitors            |
|  - Wireless       - Gaming        - 4K                |
|  - Mechanical     - Ergonomic     - Ultrawide         |
|  - Compact        - Trackballs    - Curved            |
+------------------------------------------------------+
```

### Mobile accordion (automatic)

On screens narrower than the `md` breakpoint, both styles are hidden and a vertical accordion is shown instead. Tapping a category name navigates to it; tapping the chevron expands/collapses its children.

---

## Behavior

### Caching

The component always caches the fetched category tree in `localStorage` to avoid unnecessary API calls on every render.

- **Cache key format**: `propeller_menu_{categoryId}_{language}` for anonymous users, or `propeller_menu_{categoryId}_{language}_c{contactId}` / `propeller_menu_{categoryId}_{language}_u{customerId}` for authenticated users.
- **TTL**: 12 hours (43,200,000 ms). Expired entries are removed on the next fetch attempt.
- **Quota safety**: `localStorage.setItem` is wrapped in a try/catch so the component degrades gracefully if storage is full.

### Auth-based cache invalidation

Because the cache key includes the user identifier, logging in or out automatically produces a different cache key. This means:

- Anonymous and authenticated users never share cached data.
- Switching between user accounts also uses separate cache buckets.
- No explicit cache-clearing logic is needed on auth transitions -- the `user` prop change triggers a re-fetch against the new cache key.

### Language support

- Category names and slugs are fetched using the `language` variable in the GraphQL query.
- Changing the `language` prop triggers a re-fetch (and uses a different cache key).
- The component tries to find a localized string matching the requested language; if not found, it falls back to the first available translation.

### Re-fetch triggers

The menu re-fetches when any of these props change:
- `graphqlClient`
- `categoryId`
- `language`
- `user`

On each fetch, the cache is checked first. If a valid (non-expired) cached entry exists for the current cache key, the API call is skipped entirely.

### Hover state

- **dropdown-vertical**: Tracks hovered L1 and L2 category IDs to show/hide flyout columns. Hovering a new L1 category resets the L2 hover state.
- **jumbotron**: Tracks hovered L1 to display the mega panel. L2 and L3 categories are always visible within the panel.

### CSS class hooks

| Selector | Element |
|---|---|
| `.propeller-menu` | Root wrapper `<div>` |
| `.propeller-menu-dropdown` | Desktop `<nav>` for `dropdown-vertical` style |
| `.propeller-menu-jumbotron` | Desktop `<nav>` for `jumbotron` style |
| `.propeller-menu-mobile` | Mobile accordion `<nav>` |

---

## SDK Services

### Why `graphqlClient.execute()` instead of `CategoryService`

The Propeller SDK's `CategoryService.getCategory()` returns a flat category object -- it does **not** include nested subcategories. To fetch a full category tree (multiple levels deep), the Menu component builds a recursive GraphQL query and executes it directly via `graphqlClient.execute()`.

### Internal query construction

The component constructs its query using a recursive `buildCategoriesQuery(depth)` function:

```typescript
const buildCategoriesQuery = (currentDepth: number): string => {
  if (currentDepth === 0) return '';
  return `
    categories {
      categoryId
      name(language: $language) { value language }
      slug(language: $language) { value }
      ${buildCategoriesQuery(currentDepth - 1)}
    }
  `;
};
```

This produces a nested query where the `categories` field is repeated at each level. For `depth=3`, the generated query looks like:

```graphql
query Menu($categoryId: Float, $language: String) {
  category(categoryId: $categoryId) {
    categoryId
    name(language: $language) { value language }
    slug(language: $language) { value }
    categories {
      categoryId
      name(language: $language) { value language }
      slug(language: $language) { value }
      categories {
        categoryId
        name(language: $language) { value language }
        slug(language: $language) { value }
        categories {
          categoryId
          name(language: $language) { value language }
          slug(language: $language) { value }
        }
      }
    }
  }
}
```

### Execution

```typescript
const response = await graphqlClient.execute({
  query: gql,
  variables: { categoryId: 17, language: 'NL' },
});

const rootCategory = response?.data?.category;
// rootCategory.categories -> L1 categories
// rootCategory.categories[0].categories -> L2 categories
// etc.
```

When a `user` prop is provided, the component also passes `contactId` (for Contact users) or `customerId` (for Customer users) in the query variables so the API can apply user-specific category visibility rules.

---

## SearchBar

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/navigation-and-search/search-bar

# SearchBar

A self-contained search bar with autocomplete dropdown. Fetches product results internally via `ProductService` and displays them with images, prices, and SKUs. Supports debounced input, configurable result limits, and click-outside dismissal.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage in a header

```tsx




function Header() {
  const router = useRouter();

  return (
    <SearchBar
      graphqlClient={graphqlClient}
      onSubmit={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
      onResultClick={(result) => result.url && router.push(result.url)}
      onViewAllClick={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
    />
  );
}
```

### With custom language, fallback image, and price formatter

```tsx
<SearchBar
  graphqlClient={graphqlClient}
  language="EN"
  placeholder="Search our catalog..."
  noImageUrl="/images/no-image.webp"
  formatPrice={(price) => `$${price.toFixed(2)}`}
  onSubmit={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
  onResultClick={(result) => result.url && router.push(result.url)}
  onViewAllClick={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
/>
```

### With stricter debounce and fewer results

```tsx
<SearchBar
  graphqlClient={graphqlClient}
  minSearchLength={2}
  debounceMs={500}
  maxResults={5}
  labels={{
    viewAll: 'Show all products',
    noResults: 'Nothing found for',
  }}
  onSubmit={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
  onResultClick={(result) => result.url && router.push(result.url)}
  onViewAllClick={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
/>
```

### Custom container styling

```tsx
<SearchBar
  graphqlClient={graphqlClient}
  containerClassName="relative w-full max-w-lg"
  onSubmit={(term) => router.push(`/search/${encodeURIComponent(term)}`)}
  onResultClick={(result) => result.url && router.push(result.url)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom search component that uses the same Propeller product search:

### 1. Create a ProductService instance

```ts


const productService = new ProductService(graphqlClient);
```

### 2. Call getProducts() with a search term and image variant filters

```ts
const response = await productService.getProducts({
  input: {
    term: searchTerm,
    language: 'NL',
    page: 1,
    offset: 10,
    statuses: [Enums.ProductStatus.A, Enums.ProductStatus.P],
    hidden: false,
    sortInputs: [{ field: Enums.ProductSortField.RELEVANCE, order: Enums.SortOrder.DESC }],
  },
  imageSearchFilters: { page: 1, offset: 1 },
  imageVariantFilters: {
    transformations: [{
      name: 'thumb',
      transformation: { format: Enums.Format.WEBP, height: 100, width: 100, fit: Enums.Fit.BOUNDS },
    }],
  },
});
```

### 3. Map the results

Each item in `response.items` is either a `Product` or a `Cluster`. Check for `clusterId` to distinguish them. For clusters, use `cluster.defaultProduct` for price and image data.

### 4. Handle debouncing

Use `setTimeout`/`clearTimeout` or a library like `lodash.debounce` to avoid excessive API calls on every keystroke.

### 5. Important: imageVariantFilters

Never pass an empty `imageVariantFilters` object. Always include at least one transformation entry, or omit the parameter entirely.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `graphqlClient` | `GraphQLClient` | Propeller SDK GraphQL client instance. The component creates `ProductService` internally. |

### Search Configuration

| Prop | Type | Default | Description |
|---|---|---|---|
| `language` | `string` | `'NL'` | Language code sent with search requests. |
| `placeholder` | `string` | `'Search products...'` | Placeholder text for the input field. |
| `minSearchLength` | `number` | `3` | Minimum characters typed before a search request fires. |
| `debounceMs` | `number` | `300` | Milliseconds to wait after the last keystroke before searching. |
| `maxResults` | `number` | `8` | Maximum number of suggestion results shown in the dropdown. |

### Display

| Prop | Type | Default | Description |
|---|---|---|---|
| `noImageUrl` | `string` | `''` | Fallback image URL when a result has no product image. When empty, broken image icons may appear for products without images. |
| `formatPrice` | `(price: number) => string` | Formats as `€{price}` | Custom price formatting function. |
| `labels` | `Record<string, string>` | See Labels table | Customizable UI text strings. |
| `containerClassName` | `string` | `'relative flex-1 max-w-2xl mx-8'` | CSS class for the outermost container element. |

### Callbacks

| Prop | Type | Description |
|---|---|---|
| `onSubmit` | `(term: string) => void` | Fires when the form is submitted (Enter key). Receives the trimmed search term. |
| `onResultClick` | `(result: SearchBarResult) => void` | Fires when a dropdown result is clicked. Receives the `SearchBarResult` object. |
| `onViewAllClick` | `(term: string) => void` | Fires when "View all results" is clicked. Receives the current search term. |

### SearchBarResult Interface

The result object passed to `onResultClick` and used internally:

```ts
interface SearchBarResult {
  id: number | string;
  name: string;
  sku?: string;
  price?: number;
  imageUrl?: string;
  url?: string;
  isCluster?: boolean;
}
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function searchProducts(
  graphqlClient: GraphQLClient,
  options: {
    term: string;
    language?: string;
    maxResults?: number;
  }
): Promise<SearchBarResult[]>
```

Types from `propeller-sdk-v2`: `GraphQLClient`, `ProductService`, `Product`, `Cluster`.

### Options table

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `graphqlClient` | `GraphQLClient` | *required* | `graphqlClient` prop — SDK client passed to `ProductService` |
| `term` | `string` | *required* | The search term typed by the user |
| `language` | `string` | `'NL'` | `language` prop — language code sent with search requests |
| `maxResults` | `number` | `8` | `maxResults` prop — pagination offset for results |
| `minSearchLength` | `number` | `3` | `minSearchLength` prop — minimum characters before searching |
| `debounceMs` | `number` | `300` | `debounceMs` prop — delay after last keystroke before firing search |

### Callbacks table

| Callback | When it fires | What to implement |
|----------|--------------|-------------------|
| `onSubmit` | Form is submitted (Enter key) | Navigate to full search results page with the trimmed search term |
| `onResultClick` | A dropdown result is clicked | Navigate to the product/cluster detail page using the `SearchBarResult.url` |
| `onViewAllClick` | "View all results" link is clicked | Navigate to full search results page with the current search term |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `placeholder` — placeholder text for the input field
- `noImageUrl` — fallback image URL for products without images
- `formatPrice` — custom price formatting function
- `labels` — UI string overrides (`viewAll`, `noResults`)
- `containerClassName` — CSS class for the outermost container

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `viewAll` | `'View all results'` | Text for the "view all" link at the bottom of the dropdown. |
| `noResults` | `'No products found for'` | Prefix text shown when no results match the query. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  viewAll: 'View all results',
  noResults: 'No products found for',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Debounce and minimum characters

The component waits `debounceMs` (default 300ms) after the user stops typing before making a search request. No request is made until at least `minSearchLength` (default 3) characters have been entered. If the user clears the input below the minimum length, the dropdown closes immediately.

### Image variants

Search results request 100x100 WEBP thumbnails via the `imageVariantFilters` parameter. The `imageVariantFilters` must contain a `transformations` array -- passing an empty object `{}` causes the Propeller API to return an error. If a result has no image and `noImageUrl` is provided, the fallback image is shown instead.

### Navigation on select

When a user clicks a result, the component:
1. Calls `onResultClick(result)` with the full `SearchBarResult` object
2. Closes the dropdown
3. Clears the search input

Result URLs are auto-generated as `/cluster/{id}/{slug}` for clusters or `/product/{id}/{slug}` for products. The parent component handles actual navigation in the `onResultClick` callback.

### Form submission

Pressing Enter submits the form and calls `onSubmit` with the trimmed search term. This is typically used to navigate to a full search results page.

### View all results

When the total number of matching items (`itemsFound`) exceeds `maxResults`, a "View all results (N)" link appears at the bottom of the dropdown. Clicking it calls `onViewAllClick` with the current search term.

### Click outside dismissal

The dropdown closes automatically when the user clicks anywhere outside the search bar. This is handled via a `mousedown` listener on `document`.

### Loading state

A spinning indicator appears in the input field while a search request is in progress.

---

## GraphQL Query

Under the hood, `ProductService.getProducts()` executes a query similar to:

```graphql
query SearchProducts($input: ProductSearchInput!, $imageSearchFilters: ImageSearchInput, $imageVariantFilters: ImageVariantSearchInput) {
  products(input: $input) {
    itemsFound
    items {
      productId
      clusterId
      sku
      names { value }
      slugs { value }
      price { gross net }
      defaultProduct {
        sku
        price { gross net }
        media {
          images(input: $imageSearchFilters) {
            items {
              imageVariants(input: $imageVariantFilters) {
                url
              }
            }
          }
        }
      }
      media {
        images(input: $imageSearchFilters) {
          items {
            imageVariants(input: $imageVariantFilters) {
              url
            }
          }
        }
      }
    }
  }
}
```

Variables sent by the component:

```ts
{
  input: {
    term: "search text",
    language: "NL",
    page: 1,
    offset: 8,
    statuses: ["A", "P", "T", "S"],
    hidden: false,
    sortInputs: [{ field: "RELEVANCE", order: "DESC" }],
  },
  imageSearchFilters: { page: 1, offset: 1 },
  imageVariantFilters: {
    transformations: [{
      name: "thumb",
      transformation: {
        format: "WEBP",
        height: 100,
        width: 100,
        fit: "BOUNDS",
      },
    }],
  },
}
```

**IMPORTANT**: `imageVariantFilters` must NOT be an empty object `{}`. The Propeller API rejects empty variant filters. You must always include a `transformations` array with at least one entry.

---

## SDK Services

The component uses **`ProductService`** from `propeller-sdk-v2` to fetch search suggestions. It creates the service instance internally:

```ts
const productService = new ProductService(graphqlClient);
const response = await productService.getProducts({ input, imageSearchFilters, imageVariantFilters });
```

The response items (which can be `Product` or `Cluster` objects) are mapped to `SearchBarResult` objects. For clusters, the `defaultProduct` is used for price and image data.

### Search parameters

The component searches with these fixed parameters:

- **Statuses**: `A` (active), `P` (published), `T` (temporary), `S` (special)
- **Sort**: `RELEVANCE` descending
- **Hidden**: `false`
- **Searchable attributes only**: `isSearchable: true`
- **Pagination**: page 1, offset = `maxResults`

---

## OrderItemCard

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/orders/order-item-card

# OrderItemCard

A display-only component that renders a single line item within an order or quotation table. It shows product details (image, name, SKU), quantity, pricing, discounts, and optional notes. Supports parent/child item grouping for bundled products.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic order detail table

```tsx


<table className="w-full">
  <thead>
    <tr>
      <th>Product</th>
      <th>Quantity</th>
      <th>Price</th>
    </tr>
  </thead>
  {items.map((item) => (
    <OrderItemCard key={item.id} orderItem={item} />
  ))}
</table>
```

### With parent/child grouping and discounts (quotes page)

```tsx


// Separate parent items from child items
const parentItems = allProducts.filter((item) => !item.parentOrderItemId);
const childMap = new Map();
allProducts
  .filter((item) => item.parentOrderItemId)
  .forEach((item) => {
    const children = childMap.get(item.parentOrderItemId) || [];
    children.push(item);
    childMap.set(item.parentOrderItemId, children);
  });

<table className="w-full">
  <thead>
    <tr>
      <th>Products</th>
      <th>Quantity</th>
      <th>Discount</th>
      <th>Price</th>
    </tr>
  </thead>
  {parentItems.map((item) => (
    <OrderItemCard
      key={item.id}
      orderItem={item}
      showDiscount={true}
      childItems={childMap.get(item.id) || []}
    />
  ))}
</table>
```

### Minimal display for surcharges or fee lines

```tsx
<OrderItemCard
  orderItem={feeItem}
  titleLinkable={false}
  showImage={false}
  showSku={false}
/>
```

### With custom price formatting

```tsx
<OrderItemCard
  orderItem={item}
  formatPrice={(price) => `$ ${price.toFixed(2)}`}
/>
```

### Non-linkable items (bonus items, promotions)

```tsx
<OrderItemCard orderItem={item} titleLinkable={false} />
```

### With notes and stock info visible

```tsx
<OrderItemCard
  orderItem={item}
  showItemNotes={true}
  showStockComponent={true}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom order item display:

1. Wrap your component in a `<tbody>` so it integrates with the parent `<table>`.
2. Read product details from `orderItem.product` with fallbacks to top-level `orderItem` fields (the product association may not always be populated).
3. Build the product URL from `productId` and `slug`: `/product/{productId}/{slug}`.
4. Handle child items by accepting a `childItems` array and rendering them as indented sub-rows.
5. Calculate discount percentage from `discount / originalPrice * 100` when both values are present.
6. Accept a `formatPrice` callback so consumers can control currency formatting.

### Basic order item rendering

```tsx
function CustomOrderItem({ orderItem, childItems = [] }) {
  const name = orderItem?.product?.names?.[0]?.value || orderItem?.name || 'Unknown';
  const sku = orderItem?.product?.sku || orderItem?.sku || '';
  const imageUrl = orderItem?.product?.media?.images?.items?.[0]?.imageVariants?.[0]?.url;
  const productId = orderItem?.product?.productId;
  const slug = orderItem?.product?.slugs?.[0]?.value;
  const productUrl = productId && slug ? `/product/${productId}/${slug}` : '';

  return (
    <tbody>
      <tr>
        <td>
          {productUrl ? <a href={productUrl}>{name}</a> : <span>{name}</span>}
          {sku && <p>SKU: {sku}</p>}
        </td>
        <td>{orderItem?.quantity}</td>
        <td>{orderItem?.priceTotal}</td>
      </tr>
      {childItems.map((child) => (
        <tr key={child.id || child.uuid}>
          <td style={{ paddingLeft: '2rem' }}>
            {child.product?.names?.[0]?.value || child.name}
          </td>
          <td>{child.quantity}</td>
          <td>{child.priceTotal}</td>
        </tr>
      ))}
    </tbody>
  );
}
```

### With discount display

```tsx
function CustomOrderItemWithDiscount({ orderItem, childItems = [], formatPrice }) {
  const name = orderItem?.product?.names?.[0]?.value || orderItem?.name || 'Unknown';
  const format = formatPrice || ((price: number) => `€${price.toFixed(2)}`);

  const discountAmount = orderItem?.discount;
  const originalPrice = orderItem?.originalPrice;
  const discountPercentage = discountAmount && originalPrice
    ? ((discountAmount / originalPrice) * 100).toFixed(2).replace('.', ',')
    : null;

  return (
    <tbody>
      <tr>
        <td>{name}</td>
        <td>{orderItem?.quantity}</td>
        <td>
          {discountAmount > 0 && (
            <span>{format(discountAmount)} ({discountPercentage}%)</span>
          )}
        </td>
        <td>{format(orderItem?.priceTotal)}</td>
      </tr>
      {childItems.map((child) => (
        <tr key={child.id || child.uuid}>
          <td style={{ paddingLeft: '2rem' }}>
            {child.product?.names?.[0]?.value || child.name}
          </td>
          <td>{child.quantity}</td>
          <td></td>
          <td>{format(child.priceTotal)}</td>
        </tr>
      ))}
    </tbody>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core Data

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `orderItem` | `any` | Yes | -- | The order item object to display. See "Order Item Fields" below for expected shape. |
| `childItems` | `any[]` | No | `[]` | Child/bundled items rendered as indented sub-rows beneath the parent row. |

### Display Toggles

| Prop | Type | Default | Description |
|---|---|---|---|
| `titleLinkable` | `boolean` | `true` | Render the product name as a link to the product detail page. Falls back to plain text if the product has no `productId` or `slug`. |
| `showImage` | `boolean` | `true` | Show a 64x64 product thumbnail. Forced to `false` when `isChildItem` is `true`. |
| `showSku` | `boolean` | `true` | Show the SKU beneath the product name. Forced to `false` when `isChildItem` is `true`. |
| `showQuantity` | `boolean` | `true` | Show the quantity column. |
| `showPrice` | `boolean` | `true` | Show the total price column. |
| `showDiscount` | `boolean` | `false` | Show the discount column with amount and percentage. |
| `showItemNotes` | `boolean` | `false` | Show the item notes text beneath the product name. |
| `showStockComponent` | `boolean` | `false` | Show a stock info placeholder beneath the product name. |

### Rendering Mode

| Prop | Type | Default | Description |
|---|---|---|---|
| `isChildItem` | `boolean` | `false` | Render as an indented sub-item with smaller text, no image, and no SKU. Used internally when rendering child items, but can be set manually. |

### Formatting

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatPrice` | `(price: number) => string` | Formats as `€{price.toFixed(2)}` | Custom price formatting function applied to all price values in the component. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function CustomOrderItem(options: {
  orderItem: any;
  childItems?: any[];
  formatPrice?: (price: number) => string;
}): void
```

The component is display-only and does not call any SDK services.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `orderItem` | `any` | required | `orderItem` prop |
| `childItems` | `any[]` | `[]` | `childItems` prop |
| `formatPrice` | `(price: number) => string` | `€{price.toFixed(2)}` | `formatPrice` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `titleLinkable` — whether the product name renders as a link
- `showImage` — show/hide the product thumbnail
- `showSku` — show/hide the SKU
- `showQuantity` — show/hide the quantity column
- `showPrice` — show/hide the price column
- `showDiscount` — show/hide the discount column
- `showItemNotes` — show/hide item notes
- `showStockComponent` — show/hide stock info placeholder
- `isChildItem` — render as an indented sub-item

</TabItem>
</Tabs>

---

## Order Item Fields

This component is display-only and does not call any SDK services. It reads the following fields from the `orderItem` object (typically an `OrderItem` from the Propeller SDK):

### Product Information

| Field Path | Purpose |
|---|---|
| `orderItem.product.names[0].value` | Product display name (primary source) |
| `orderItem.name` | Product display name (fallback) |
| `orderItem.product.sku` | Product SKU (primary source) |
| `orderItem.sku` | Product SKU (fallback) |
| `orderItem.product.productId` | Used to build the product detail page URL |
| `orderItem.product.slugs[0].value` | Used to build the product detail page URL |
| `orderItem.product.media.images.items[0].imageVariants[0].url` | Product thumbnail URL |

### Pricing and Quantity

| Field Path | Purpose |
|---|---|
| `orderItem.quantity` | Item quantity |
| `orderItem.price` | Unit price |
| `orderItem.priceTotal` | Total price for the line (displayed in the price column) |
| `orderItem.discount` | Discount amount |
| `orderItem.originalPrice` | Original price before discount (used to calculate discount percentage) |

### Other

| Field Path | Purpose |
|---|---|
| `orderItem.notes` | Item-level notes (shown when `showItemNotes` is enabled) |
| `orderItem.parentOrderItemId` | Identifies child items -- items with this field set belong to a parent item |
| `orderItem.id` | Used as the React key when rendering |

Child items read a subset: `product.names[0].value`, `name`, `quantity`, `priceTotal`, `id`, and `uuid`.

---

## Behavior

### HTML Structure

The component renders a `<tbody>` element containing one or more `<tr>` rows. Because of this, it must be placed directly inside a `<table>` -- do not wrap it in another `<tbody>`.

### Child Items

Items with a `parentOrderItemId` are children belonging to a parent item. The parent page is responsible for:

1. Filtering parent items (those without `parentOrderItemId`)
2. Building a lookup of `parentId -> childItems[]`
3. Passing the children via the `childItems` prop on the parent's `OrderItemCard`

Child rows render with left indentation (`pl-28`), smaller text, no border, no image, and no discount. They share the parent's column visibility settings for quantity and price.

### Price Display

- The price column shows `priceTotal` (the line total), not the unit price.
- Default formatting is `€` followed by two decimal places (e.g., `€127.50`).
- Pass `formatPrice` to override formatting for all prices in the component (unit prices, totals, and discount amounts).

### Discount Display

When `showDiscount` is `true`:

- Shows the discount amount formatted by `formatPrice`, followed by the percentage in parentheses: e.g., `€127.50 (15,00%)`
- Percentage is calculated as `(discount / originalPrice) * 100`
- The percentage uses comma as decimal separator
- Rendered in orange text
- Empty cell when the item has no discount
- Child items never show discount values

### Image Handling

- Displays a 64x64 thumbnail from the first image variant of the first media image
- When no image URL is available, shows a gray placeholder with "No Img" text
- Images are hidden entirely when `showImage` is `false` or when rendering a child item
- The compiled React version uses Next.js `Image` and `Link` components instead of plain HTML tags

### Title Linking

- When `titleLinkable` is `true` (default), the product name links to `/product/{productId}/{slug}`
- If the product lacks a `productId` or `slug`, the title falls back to plain text automatically
- Child items never render as links, regardless of the `titleLinkable` setting

### Stock Info

The `showStockComponent` prop renders a placeholder text. Replace it with an actual stock display component as needed for your application.

---

## OrderList

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/orders/order-list

# OrderList

A self-contained, paginated order list that fetches orders from the Propeller GraphQL API. Supports text search, date/price range filters, sorting, status filtering, and company-aware queries for B2B users.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Orders page (basic)

```tsx



<OrderList
  graphqlClient={graphqlClient}
  user={user}
  onOrderClick={(orderId) => router.push(`/account/orders/${orderId}`)}
  enableSearch={true}
  searchFields={['term', 'createdAt']}
  columns={['id', 'date', 'status', 'total', 'action']}
  columnConfig={{ id: '#', date: 'Date', status: 'Status', total: 'Total', action: '' }}
/>
```

### Quotes page (with status filter and validUntil column)

Filter by `QUOTATION` status and add the `validUntil` column to show quote expiry dates:

```tsx
<OrderList
  graphqlClient={graphqlClient}
  user={user}
  orderStatus={['QUOTATION']}
  columns={['id', 'date', 'status', 'validUntil', 'total']}
  columnConfig={{
    id: '#',
    date: 'Date',
    status: 'Status',
    validUntil: 'Valid until',
    total: 'Total',
  }}
  rowsClickable={true}
  enableSearch={true}
  searchFields={['term', 'createdAt', 'price']}
  onOrderClick={(orderId) => router.push(`/account/quotes/${orderId}`)}
/>
```

### B2B with company filter (CompanyContext integration)

For Contact users who belong to multiple companies, pass the active company ID so orders are scoped to that company. The component re-fetches automatically when `companyId` changes.

```tsx


const { selectedCompany } = useCompany();
const isContact = (u: any) => u !== null && 'company' in u;
const getActiveCompany = () =>
  !user || !isContact(user) ? null : selectedCompany ?? null;

<OrderList
  graphqlClient={graphqlClient}
  user={user}
  companyId={getActiveCompany()?.companyId}
  onOrderClick={(orderId) => router.push(`/account/orders/${orderId}`)}
  enableSearch={true}
  searchFields={['term', 'createdAt', 'price']}
  columns={['id', 'date', 'status', 'total', 'action']}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

Standalone implementation using the SDK directly:

```ts

  OrderService,
  OrderSearchArguments,
  Order,
  Enums,
  GraphQLClient,
} from 'propeller-sdk-v2';

// pseudo-code

// 1. Initialize the service
const orderService = new OrderService(graphqlClient);

// 2. Build search arguments
const itemsPerPage = 10;
const args: OrderSearchArguments = {
  status: ['NEW', 'CONFIRMED', 'VALIDATED', 'ORDER'],
  userId: [userId],
  ...(companyId && { companyIds: [companyId] }),
  page: 1,
  offset: itemsPerPage,
  term: '',
  termFields: [
    Enums.OrderSearchFields.REFERENCE,
    Enums.OrderSearchFields.ITEM_SKU,
    Enums.OrderSearchFields.ID,
  ],
};

// 3. Fetch orders
const response = await orderService.getOrders(args);
const orders: Order[] = response.items || [];
const totalPages = Math.ceil((response.itemsFound || 0) / itemsPerPage);
```

**Data mapping per order row:**

| Field | Source |
|---|---|
| Order ID | `order.id` |
| Date | `new Date(order.date \|\| order.createdAt \|\| '').toLocaleDateString()` |
| Status | `order.status` |
| Total | `order.total?.net` (format as currency, e.g., `EUR X.XX`) |

**Quotes with company filter:**

```ts
// pseudo-code: fetch quotes scoped to a specific company
const quoteArgs: OrderSearchArguments = {
  status: ['QUOTATION'],
  userId: [userId],
  companyIds: [companyId],
  page: 1,
  offset: 10,
  term: '',
  termFields: [
    Enums.OrderSearchFields.REFERENCE,
    Enums.OrderSearchFields.ITEM_SKU,
    Enums.OrderSearchFields.ID,
  ],
};

const quoteResponse = await orderService.getOrders(quoteArgs);
```

**UI structure:**

- Show a loading indicator while fetching. Show an empty-state message when `orders` is empty.
- Render a table with columns for order ID, date, status, and total. Each row should be clickable to navigate to the order detail.
- When `totalPages > 1`, render Previous/Next pagination controls. Track the current page number in your framework's state mechanism and re-fetch orders when it changes.
- Re-fetch when `userId`, `companyId`, or the current page changes.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `user` | `Contact \| Customer \| null` | The authenticated user. Component does not fetch until a user is provided. |
| `graphqlClient` | `GraphQLClient` | Initialized SDK GraphQL client instance. |
| `onOrderClick` | `(orderId: number) => void` | Called when an order row or "View" button is clicked. |

### Display

| Prop | Type | Default | Description |
|---|---|---|---|
| `columns` | `string[]` | `['id', 'date', 'status', 'total']` | Column keys to render. Built-in renderers exist for `id`, `date`, `status`, `total`, `validUntil`, `action`. Any other key renders `order[key]` as plain text. |
| `columnConfig` | `Record<string, string>` | Auto-capitalized key | Maps column keys to display labels for table headers. |
| `className` | `string` | `undefined` | CSS class applied to the root wrapper `<div>`. |
| `rowsClickable` | `boolean` | `false` | When `true`, the entire row is clickable (calls `onOrderClick`) and the `action` column button is hidden. |

### Filtering and Search

| Prop | Type | Default | Description |
|---|---|---|---|
| `orderStatus` | `string[]` | `['NEW', 'CONFIRMED', 'VALIDATED', 'ORDER']` | Status codes to filter by. Use `['QUOTATION']` for quotes. |
| `companyId` | `number` | `undefined` | Override company ID for order filtering. Falls back to `user.company.companyId` for Contact users. Omitted entirely for Customer users. |
| `enableSearch` | `boolean` | `false` | Show the search panel above the table. |
| `searchFields` | `string[]` | `[]` | Which search inputs to render. Options: `'term'`, `'createdAt'`, `'lastModifiedAt'`, `'price'`, `'sortInput'`, `'type'`. When `enableSearch` is `true`, `'term'` is automatically prepended if not already present. See [search field types](#search-field-types) for input types and API mapping. |
| `termFields` | `OrderSearchFields[]` | `[REFERENCE, ITEM_SKU, ID, ITEM_NAME, REMARKS]` | Backend fields searched when the user types a text query. Uses `Enums.OrderSearchFields` values. |

### Pagination

| Prop | Type | Default | Description |
|---|---|---|---|
| `initialItemsPerPage` | `number` | `10` | Number of orders per page. |

### Formatting and Localization

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatPrice` | `(price: number) => string` | Formats as `EUR X.XX` | Custom price formatter. |
| `formatDate` | `(dateString: string) => string` | `toLocaleDateString()` | Custom date formatter. |
| `getStatusColor` | `(status: string) => string` | Built-in color map | Returns Tailwind class string for the status badge. |
| `labels` | `object` | English defaults | UI text overrides (see Labels section). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchOrders(
  graphqlClient: GraphQLClient,
  args: OrderSearchArguments
): Promise<{ items: Order[]; itemsFound: number; offset: number }> {
  const orderService = new OrderService(graphqlClient);
  return await orderService.getOrders(args);
}
```

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `status` | `string[]` | `['NEW', 'CONFIRMED', 'VALIDATED', 'ORDER']` | `orderStatus` prop |
| `userId` | `number[]` | -- | Derived from `user` prop |
| `companyIds` | `number[]` | -- | `companyId` prop |
| `page` | `number` | `1` | Internal page counter |
| `offset` | `number` | `10` | `initialItemsPerPage` prop |
| `term` | `string` | `''` | Search text input |
| `termFields` | `OrderSearchFields[]` | `[REFERENCE, ITEM_SKU, ID, ITEM_NAME, REMARKS]` | `termFields` prop |
| `createdAt` | `{ greaterThan, lessThan }` | -- | `createdAt` search field |
| `price` | `{ greaterThan, lessThan }` | -- | `price` search field |
| `sortInput` | `{ field, order }` | -- | `sortInput` search field |
| `type` | `OrderType` | -- | `type` search field |

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onOrderClick` | User clicks an order row or "View" button | Navigate to the order detail page |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. You are responsible for implementing equivalent behavior in your custom UI:

`className`, `columns`, `columnConfig`, `rowsClickable`, `enableSearch`, `searchFields`, `formatPrice`, `formatDate`, `getStatusColor`, `labels`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All fields are optional. Defaults are English strings.

```ts
{
  view?: string;        // "View" button text (default: "View")
  previous?: string;    // Pagination previous button (default: "Previous")
  next?: string;        // Pagination next button (default: "Next")
  showingPage?: string; // Page indicator prefix (default: "Showing page")
  of?: string;          // Page indicator separator (default: "of")
  noOrders?: string;    // Empty state message (default: "No orders found.")
  loading?: string;     // Loading spinner text (default: "Loading orders...")
  order?: string;
  date?: string;
  status?: string;
  total?: string;
  action?: string;
}
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  view: 'View',
  previous: 'Previous',
  next: 'Next',
  showingPage: 'Showing page',
  of: 'of',
  noOrders: 'No orders found.',
  loading: 'Loading orders...',
  order: 'order',
  date: 'date',
  status: 'status',
  total: 'total',
  action: 'action',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Pagination

- Page-based pagination using `page` and `offset` (items per page) parameters.
- Pagination controls appear only when `totalPages > 1`.
- Mobile: simplified Previous/Next buttons. Desktop: page indicator ("Showing page X of Y") with Previous/Next buttons.
- The `initialItemsPerPage` prop sets the page size (default 10). The API response `offset` can override this.

### Search

- The search panel only renders when `enableSearch={true}` and at least one search field is configured.
- The `term` field is automatically added when `enableSearch` is `true`, even if not listed in `searchFields`.
- Pressing Enter in the term input triggers a search. A "Search" button and "Clear" button are also provided.
- Searching always resets to page 1.

### Search field types

| Field | Input type | Sent as |
|---|---|---|
| `term` | Text (full width) | `term: string` |
| `createdAt` | Two date pickers (from/to) | `createdAt: { greaterThan, lessThan }` |
| `lastModifiedAt` | Two date pickers (from/to) | `lastModifiedAt: { greaterThan, lessThan }` |
| `price` | Two number inputs (min/max) | `price: { greaterThan, lessThan }` |
| `sortInput` | Two dropdowns (field + order) | `sortInput: { field, order }` |
| `type` | Dropdown (order type) | `type: OrderType` |

### Column renderers

Six column keys have built-in rendering logic:

| Column | Rendering |
|---|---|
| `id` | Bold text, `order.id` |
| `date` | Formatted date from `order.date` or `order.createdAt` |
| `status` | Colored badge using `getStatusColor()` |
| `total` | Right-aligned, formatted price from `order.total.net` |
| `validUntil` | Formatted date from `order.validUntil` (useful for quote expiry) |
| `action` | "View" button that calls `onOrderClick`. Hidden when `rowsClickable` is `true`. |

Any other column key falls through to render `order[columnKey]` as plain text, allowing access to any field on the Order object.

### Status colors (defaults)

| Status | Style |
|---|---|
| `COMPLETE`, `QUOTE_ACCEPTED` | Green-tinted badge (`bg-secondary/10 text-secondary`) |
| `CANCELLED`, `QUOTE_REJECTED` | Red badge (`bg-red-100 text-red-800`) |
| All others | Yellow badge (`bg-yellow-100 text-yellow-800`) |

Override with the `getStatusColor` prop to return your own Tailwind class string.

### Company filtering

- **`companyId` prop provided**: Filters orders by that company via `companyIds` in the search arguments.
- **`companyId` prop omitted, Contact user**: Falls back to `user.company.companyId`.
- **Customer user (B2C)**: `companyIds` is not included in the query. Customers see only their own orders.
- The component re-fetches when `companyId` changes, enabling live updates from a company switcher.

### Status codes

Common status strings used with `orderStatus`:

| Status | Usage |
|---|---|
| `NEW` | Newly placed order |
| `CONFIRMED` | Order confirmed |
| `VALIDATED` | Order validated |
| `ORDER` | Active order |
| `COMPLETE` | Fulfilled order |
| `CANCELLED` | Cancelled order |
| `QUOTATION` | Quote / request for quotation |
| `QUOTE_ACCEPTED` | Accepted quote |
| `QUOTE_REJECTED` | Rejected quote |

Default filter (when `orderStatus` is not provided): `['NEW', 'CONFIRMED', 'VALIDATED', 'ORDER']`.

### Re-fetch triggers

The component fetches orders on mount and re-fetches when any of these change:
- `user` (login/logout)
- `currentPage` (pagination)
- `companyId` (company switcher)

A `fetching` guard prevents concurrent requests.

## GraphQL Query Examples

Under the hood, `OrderService.getOrders()` executes a GraphQL query. Here are equivalent raw queries for reference.

### Paginated orders with search

```graphql
query Orders($input: OrderSearchArguments!) {
  orders(input: $input) {
    items {
      id
      date
      createdAt
      status
      total {
        net
        gross
      }
    }
    itemsFound
    offset
    page
  }
}
```

Variables for a basic paginated fetch:

```json
{
  "input": {
    "status": ["NEW", "CONFIRMED", "VALIDATED", "ORDER"],
    "userId": [12345],
    "page": 1,
    "offset": 10,
    "term": "",
    "termFields": ["REFERENCE", "ITEM_SKU", "ID", "ITEM_NAME", "REMARKS"]
  }
}
```

### Quotes with company filter

```json
{
  "input": {
    "status": ["QUOTATION"],
    "userId": [12345],
    "companyIds": [678],
    "page": 1,
    "offset": 10,
    "term": ""
  }
}
```

### Orders with date range and price filter

```json
{
  "input": {
    "status": ["NEW", "CONFIRMED", "ORDER"],
    "userId": [12345],
    "page": 1,
    "offset": 20,
    "term": "SKU-001",
    "termFields": ["ITEM_SKU", "REFERENCE"],
    "createdAt": {
      "greaterThan": "2025-06-01T00:00:00Z",
      "lessThan": "2025-12-31T23:59:59Z"
    },
    "price": {
      "greaterThan": 100.0,
      "lessThan": 1000.0
    },
    "sortInput": {
      "field": "DATE",
      "order": "DESC"
    }
  }
}
```

## SDK Services

The component uses `OrderService` from `propeller-sdk-v2` internally:

```ts


const orderService = new OrderService(graphqlClient);
const response = await orderService.getOrders(searchArgs);
// response.items    — Order[]
// response.itemsFound — total count
// response.offset   — items per page
```

The `OrderSearchArguments` object controls all filtering, pagination, and sorting:

```ts
const searchArgs: OrderSearchArguments = {
  status: ['NEW', 'CONFIRMED', 'VALIDATED', 'ORDER'],
  userId: [userId],
  companyIds: [companyId],       // optional, B2B only
  page: 1,
  offset: 10,                   // items per page
  term: 'search text',
  termFields: [
    Enums.OrderSearchFields.REFERENCE,
    Enums.OrderSearchFields.ITEM_SKU,
    Enums.OrderSearchFields.ID,
    Enums.OrderSearchFields.ITEM_NAME,
    Enums.OrderSearchFields.REMARKS,
  ],
  createdAt: {                   // optional date range
    greaterThan: '2025-01-01T00:00:00Z',
    lessThan: '2025-12-31T23:59:59Z',
  },
  price: {                       // optional price range
    greaterThan: 50.0,
    lessThan: 500.0,
  },
  sortInput: {                   // optional sorting
    field: Enums.OrderSortField.DATE,
    order: Enums.SortOrder.DESC,
  },
  type: Enums.OrderType.ORDER,   // optional type filter
};
```

---

## OrderSummary

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/orders/order-summary

# OrderSummary

Displays a complete order overview including order metadata (number, date, status, total), invoice and delivery addresses, payment/carrier/delivery information, and order remarks. Designed for order detail and order confirmation pages.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Full order summary with all sections visible (default)

```tsx


<OrderSummary order={order} title="Order Summary" />
```

### Minimal view — metadata only, no addresses or delivery info

```tsx
<OrderSummary
  order={order}
  title="Order #12345"
  showInvoiceAddress={false}
  showDeliveryAddress={false}
  showDeliveryInfo={false}
  showRemarks={false}
/>
```

### Custom price and date formatting with Dutch labels

```tsx
<OrderSummary
  order={order}
  formatPrice={(price) => `€ ${price.toFixed(2).replace('.', ',')}`}
  formatDate={(dateStr) =>
    new Date(dateStr).toLocaleDateString('nl-NL', {
      year: 'numeric',
      month: 'long',
      day: 'numeric',
    })
  }
  labels={{
    orderNumber: 'Bestelnummer',
    orderDate: 'Besteldatum',
    status: 'Status',
    total: 'Totaal',
    invoiceAddress: 'Factuuradres',
    deliveryAddress: 'Afleveradres',
    payment: 'Betaling:',
    carrier: 'Vervoerder:',
    deliveryDate: 'Leverdatum:',
    reference: 'Referentie:',
    remarks: 'Opmerkingen:',
  }}
/>
```

### With country code resolution

```tsx


<OrderSummary
  order={order}
  countries={countries}
/>
```

### Quote detail — hide total (shown separately via OrderTotals)

```tsx
<OrderSummary
  order={quote}
  title="Quote Details"
  showOrderTotal={false}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom order summary that fits your design system:

1. **Fetch the order** using `OrderService.getOrder({ id: orderId })` from the Propeller SDK.

2. **Extract addresses** by filtering `order.addresses` on the `type` field:
   ```tsx
   const invoiceAddress = order.addresses?.find(a => a.type === 'invoice');
   const deliveryAddress = order.addresses?.find(a => a.type === 'delivery');
   ```

3. **Read the total** from `order.total.net` (includes VAT). For a full financial breakdown, pair with the `OrderTotals` component.

4. **Read delivery info** from `order.paymentData.method`, `order.postageData.carrier`, and `order.postageData.requestDate`.

5. **Format prices and dates** consistently across your app by passing shared formatter functions.

6. **Resolve country codes** by passing a country list. The `@/data/countries` module provides a ready-made list of `{ code, name }` objects.

### Minimal example

```ts
// Fetch the order (using OrderService documented in SDK Services)
// const order = await orderService.getOrder({ id: orderId });

const invoiceAddress = order.addresses?.find(a => a.type === 'invoice');
const deliveryAddress = order.addresses?.find(a => a.type === 'delivery');

const orderTotal = order.total?.net ?? 0;
const formattedTotal = `€${orderTotal.toFixed(2)}`;

const orderDate = order.createdAt
  ? new Date(order.createdAt).toLocaleDateString('en-US', {
      year: 'numeric', month: 'long', day: 'numeric'
    })
  : '';

const paymentMethod = order.paymentData?.method;
const carrier = order.postageData?.carrier;
const deliveryDate = order.postageData?.requestDate;
const reference = order.reference;
const remarks = order.remarks;

// Render these values in your custom layout
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `order` | `any` | Yes | -- | The order object from the Propeller SDK |
| `title` | `string` | No | -- | Heading rendered above the summary. Omit to hide. |
| `orderSummaryContainerClass` | `string` | No | `'order-summary'` | CSS class applied to the root container |

### Visibility Toggles

All default to `true`. Set to `false` to hide the corresponding section.

| Prop | Type | Controls |
|---|---|---|
| `showOrderNumber` | `boolean` | Order number in the metadata row |
| `showOrderDate` | `boolean` | Order date in the metadata row |
| `showOrderStatus` | `boolean` | Status badge in the metadata row |
| `showOrderTotal` | `boolean` | Total price in the metadata row |
| `showInvoiceAddress` | `boolean` | Invoice address block |
| `showDeliveryAddress` | `boolean` | Delivery address block |
| `showDeliveryInfo` | `boolean` | Payment method, carrier, and delivery date panel |
| `showRemarks` | `boolean` | Reference and remarks panel |

### Formatting and Localization

| Prop | Type | Default | Description |
|---|---|---|---|
| `formatPrice` | `(price: number) => string` | Formats as `€X.XX` | Custom price formatter for the order total |
| `formatDate` | `(dateString: string) => string` | `en-US` long date (e.g., "March 25, 2026") | Custom date formatter for order date and delivery date |
| `labels` | `Record<string, string>` | English defaults | Override any UI label (see Label Keys below) |
| `countries` | `{ code: string; name: string }[]` | `[]` | Country list for resolving ISO codes to display names. When omitted, raw country codes are shown. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderOrderSummary(options: {
  order: any;
  formatPrice?: (price: number) => string;
  formatDate?: (dateString: string) => string;
  countries?: { code: string; name: string }[];
}): void
```

The component is read-only. It receives an `Order` object (typically fetched via `OrderService.getOrder()`) and reads fields directly.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `order` | `any` | required | `order` prop |
| `formatPrice` | `(price: number) => string` | `€X.XX` | `formatPrice` prop |
| `formatDate` | `(dateString: string) => string` | `en-US` long date | `formatDate` prop |
| `countries` | `{ code: string; name: string }[]` | `[]` | `countries` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `title` — heading text above the summary
- `orderSummaryContainerClass` — CSS class on the root container
- `showOrderNumber` — toggle order number display
- `showOrderDate` — toggle order date display
- `showOrderStatus` — toggle status badge display
- `showOrderTotal` — toggle total price display
- `showInvoiceAddress` — toggle invoice address block
- `showDeliveryAddress` — toggle delivery address block
- `showDeliveryInfo` — toggle payment/carrier/delivery panel
- `showRemarks` — toggle reference and remarks panel
- `labels` — UI string overrides

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default Value |
|---|---|
| `orderNumber` | `"Order Number"` |
| `orderDate` | `"Order Date"` |
| `status` | `"Status"` |
| `total` | `"Total"` |
| `invoiceAddress` | `"Invoice Address"` |
| `deliveryAddress` | `"Delivery Address"` |
| `payment` | `"Payment:"` |
| `carrier` | `"Carrier:"` |
| `deliveryDate` | `"Delivery Date:"` |
| `reference` | `"Reference:"` |
| `remarks` | `"Remarks:"` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  orderNumber: 'Order Number',
  orderDate: 'Order Date',
  status: 'Status',
  total: 'Total',
  invoiceAddress: 'Invoice Address',
  deliveryAddress: 'Delivery Address',
  payment: 'Payment:',
  carrier: 'Carrier:',
  deliveryDate: 'Delivery Date:',
  reference: 'Reference:',
  remarks: 'Remarks:',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## SDK Services

OrderSummary is a **read-only** component. It does not call any SDK services directly. It receives an `Order` object (typically fetched via `OrderService.getOrder()`) and reads the following fields:

### Order Fields

| Field Path | Type | Used For |
|---|---|---|
| `order.id` | `number` | Order number display |
| `order.createdAt` | `string` | Order date, formatted via `formatDate` |
| `order.status` | `string` | Status badge (e.g., `"NEW"`, `"CONFIRMED"`, `"QUOTATION"`) |
| `order.total.net` | `number` | Order total, formatted via `formatPrice` |
| `order.reference` | `string` | Customer-provided reference |
| `order.remarks` | `string` | Customer-provided remarks/notes |

### Address Fields (from `order.addresses[]`)

The component filters `order.addresses` by `type` to find the invoice (`type === 'invoice'`) and delivery (`type === 'delivery'`) addresses. Each address object is expected to have:

| Field | Type | Notes |
|---|---|---|
| `company` | `string` | Shown first when present |
| `firstName` | `string` | Combined into a full name line |
| `middleName` | `string` | Combined into a full name line |
| `lastName` | `string` | Combined into a full name line |
| `street` | `string` | Combined with number into a street line |
| `number` | `string` | House/building number |
| `numberExtension` | `string` | Optional number suffix |
| `postalCode` | `string` | Combined with city |
| `city` | `string` | Combined with postal code |
| `country` | `string` | ISO country code, resolved via `countries` prop |
| `email` | `string` | Shown in muted text below the address |

### Payment and Delivery Fields

| Field Path | Type | Used For |
|---|---|---|
| `order.paymentData.method` | `string` | Payment method name |
| `order.postageData.carrier` | `string` | Carrier/shipping provider name |
| `order.postageData.requestDate` | `string` | Requested delivery date, formatted via `formatDate` |

---

## Behavior

- **Layout**: The component renders in four visual sections stacked vertically:
  1. **Metadata row** -- a responsive grid (1 column on mobile, up to 4 on desktop) showing order number, date, status badge, and total.
  2. **Addresses** -- a two-column grid with invoice and delivery addresses side by side.
  3. **Delivery info panel** -- a bordered card showing payment method, carrier, and delivery date as key-value rows. Only rendered when at least one of the three values is present.
  4. **Remarks panel** -- a bordered card showing reference and remarks as key-value rows. Only rendered when at least one of the two values is present.

- **Conditional rendering**: Each section is independently controlled by its visibility prop. Within sections, individual fields are hidden when their data is empty or missing from the order object. The delivery info and remarks panels are fully hidden when all their child values are empty, even if the visibility prop is `true`.

- **Date formatting**: Falls back to `en-US` long format (`toLocaleDateString`) when no `formatDate` prop is provided. If parsing fails, the raw date string is returned as-is.

- **Price formatting**: Falls back to `€` prefix with two decimal places when no `formatPrice` prop is provided. Treats `null`/`undefined` prices as `0`.

- **Country resolution**: When the `countries` prop is provided, ISO country codes in addresses are resolved to full country names. When omitted or when no match is found, the raw code is displayed.

- **Status badge**: The order status is rendered as a pill-shaped badge with `bg-secondary/10` and `text-secondary` styling.

---

## OrderTotals

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/orders/order-totals

# OrderTotals

A display-only financial summary for orders and quotations. Renders subtotal, discounts, shipping costs, transaction costs, VAT breakdowns, and the grand total. Each row can be toggled on or off, and all labels and price formatting are fully customizable.

The component handles presentation only -- it does not perform any API calls, mutations, or side effects.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### All defaults

```tsx


<OrderTotals order={order} />
```

### Minimal summary (hide VAT details)

```tsx
<OrderTotals
  order={order}
  showVATs={false}
  showTotalVat={false}
  showTotalExclVat={false}
/>
```

### Custom labels (Dutch)

```tsx
<OrderTotals
  order={quote}
  labels={{
    subtotal: 'Subtotaal:',
    discount: 'Korting:',
    subtotalWithDiscount: 'Subtotaal met korting:',
    transactionCosts: 'Transactiekosten:',
    shippingCosts: 'Verzendkosten:',
    totalExclVat: 'Totaal excl. BTW:',
    vat: 'BTW',
    totalVat: 'Totaal BTW:',
    total: 'Totaal:',
  }}
/>
```

### Custom price formatting

```tsx
<OrderTotals
  order={order}
  formatPrice={(price) => `$ ${price.toFixed(2)}`}
/>
```

### Quote detail page (real-world example)

```tsx
<OrderTotals
  order={quote}
  title="Quote summary"
  showShippingCosts={false}
  labels={{
    subtotal: 'Subtotal:',
    discount: 'Discount:',
    total: 'Quote total:',
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom order totals component, you need:

1. **Accept an `Order` prop** -- the component is stateless; all data comes from the order object.

2. **Read totals from `order.total`** -- `gross` for the pre-VAT amount, `net` for the final amount including VAT, `taxPercentages` for the VAT breakdown.

3. **Check discount presence** -- only show the discount row when `discountType !== 'N'` and `discountValue > 0`. Format the display value based on whether the type is `A` (format as currency) or `P` (append `%`).

4. **Check costs presence** -- shipping (`order.postageData.gross > 0`) and transaction costs (`order.paymentData.gross > 0`) should only appear when they have a value.

5. **Compute total VAT** -- sum up `total` from each entry in `order.total.taxPercentages` that has both `percentage > 0` and `total > 0`.

6. **Format prices consistently** -- use a single formatting function for all monetary values so currency symbol and decimal handling are uniform.

### Example skeleton

```tsx
function CustomOrderTotals({ order }: { order: Order }) {
  const total = order.total;
  const hasDiscount = total.discountType !== 'N' && total.discountValue > 0;

  return (
    <div>
      <Row label="Subtotal" value={total.gross} />
      {hasDiscount && <DiscountRow type={total.discountType} value={total.discountValue} />}
      {order.postageData?.gross > 0 && <Row label="Shipping" value={order.postageData.gross} />}
      {order.paymentData?.gross > 0 && <Row label="Transaction" value={order.paymentData.gross} />}
      <Row label="Total excl. VAT" value={total.gross} />
      {total.taxPercentages?.map((tax) => (
        <Row key={tax.percentage} label={`${tax.percentage}% VAT`} value={tax.total} />
      ))}
      <Row label="Total" value={total.net} bold />
    </div>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `order` | `Order` | Yes | -- | The order or quote object to display totals for |

### Display toggles

All toggles default to `true`. The grand total row is always visible and cannot be hidden.

| Prop | Type | Default | Description |
|---|---|---|---|
| `showSubtotal` | `boolean` | `true` | Show the subtotal row |
| `showDiscount` | `boolean` | `true` | Show discount row (only renders when the order actually has a discount) |
| `showShippingCosts` | `boolean` | `true` | Show shipping costs (only renders when shipping costs are present) |
| `showVATs` | `boolean` | `true` | Show individual VAT rate rows |
| `showTotalExclVat` | `boolean` | `true` | Show total excluding VAT |
| `showTotalVat` | `boolean` | `true` | Show total VAT amount |

### Customization

| Prop | Type | Default | Description |
|---|---|---|---|
| `title` | `string` | `'Order summary'` | Block title (not currently rendered in the template but available for wrapper use) |
| `labels` | `Record<string, string>` | See table below | Override any row label |
| `formatPrice` | `(price: number) => string` | ``(p) => `€${p.toFixed(2)}` `` | Custom price formatter applied to every monetary value |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderOrderTotals(options: {
  order: Order;
  formatPrice?: (price: number) => string;
}): void
```

The component is display-only. It reads from the `Order` object that the parent fetches (typically via `OrderService`).

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `order` | `Order` | required | `order` prop |
| `formatPrice` | `(price: number) => string` | ``€${p.toFixed(2)}`` | `formatPrice` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `title` — block title
- `showSubtotal` — toggle subtotal row
- `showDiscount` — toggle discount row
- `showShippingCosts` — toggle shipping costs row
- `showVATs` — toggle individual VAT rate rows
- `showTotalExclVat` — toggle total excluding VAT row
- `showTotalVat` — toggle total VAT row
- `labels` — UI string overrides

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default value | Where it appears |
|---|---|---|
| `subtotal` | `Subtotal:` | Subtotal row |
| `discount` | `Discount:` | Discount row |
| `subtotalWithDiscount` | `Subtotal with discount:` | Subtotal-after-discount row |
| `transactionCosts` | `Transaction costs:` | Transaction/payment costs row |
| `shippingCosts` | `Shipping costs:` | Shipping/postage costs row |
| `totalExclVat` | `Total excl. VAT:` | Total excluding VAT row |
| `vat` | `VAT` | Each VAT rate row (rendered as `{percentage}% VAT:`) |
| `totalVat` | `Total VAT:` | Summed VAT row |
| `total` | `Total:` | Grand total row |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  subtotal: 'Subtotal:',
  discount: 'Discount:',
  subtotalWithDiscount: 'Subtotal with discount:',
  transactionCosts: 'Transaction costs:',
  shippingCosts: 'Shipping costs:',
  totalExclVat: 'Total excl. VAT:',
  vat: 'VAT',
  totalVat: 'Total VAT:',
  total: 'Total:',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## SDK Services

OrderTotals is a pure display component -- it does not call any SDK service. It reads from the `Order` object that the parent fetches (typically via `OrderService`).

### Order type fields used

| Field | Type | Description |
|---|---|---|
| `order.total.gross` | `number` | Subtotal and total excluding VAT |
| `order.total.net` | `number` | Grand total including VAT |
| `order.total.discountType` | `OrderDiscountType` | Discount kind: `A` = absolute amount, `P` = percentage, `N` = none |
| `order.total.discountValue` | `number` | The raw discount value (currency amount for `A`, percentage number for `P`) |
| `order.total.taxPercentages` | `Array<{ percentage: number; total: number }>` | Per-rate VAT breakdown |
| `order.postageData.gross` | `number` | Shipping costs (excl. VAT) |
| `order.paymentData.gross` | `number` | Transaction/payment costs (excl. VAT) |

### OrderDiscountType enum

Accessed via `Enums.OrderDiscountType`:

| Value | Meaning | Display format |
|---|---|---|
| `A` | Absolute amount | `-€{discountValue}` (formatted through `formatPrice`) |
| `P` | Percentage | `- {discountValue}%` |
| `N` | No discount | Row is hidden entirely |

---

## Behavior

### Discount display

- The discount row only appears when **both** `showDiscount` is `true` **and** the order has an active discount (`discountType` is not `N` and `discountValue > 0`).
- When a discount is present, an additional "subtotal with discount" row appears directly below it, showing `gross - discountValue`.
- Absolute discounts (`A`) are formatted through `formatPrice` with a leading `-` sign.
- Percentage discounts (`P`) display as `- {value}%` without currency formatting.

### VAT breakdown

- Each entry in `order.total.taxPercentages` with a non-zero `percentage` and `total` renders as its own row (e.g., "21% VAT: ...").
- The "Total VAT" row sums all qualifying tax entries.
- Zero-rate or zero-total tax entries are filtered out automatically.

### Price formatting

- The default formatter outputs prices as `€{value}` with two decimal places (e.g., `€12.50`).
- Passing a `formatPrice` function overrides formatting for every monetary value in the component -- subtotal, discount amounts, shipping, transaction costs, VAT, and totals.
- Null or undefined prices are treated as `0`.

### Transaction costs

- Transaction costs always render when `order.paymentData.gross > 0`. There is no toggle prop for this row because transaction costs are considered a mandatory line item.

### Grand total

- The grand total row (`order.total.net`) is always visible and cannot be hidden by any prop. It renders with bold styling and a top border to visually separate it from the other rows.

---

## ItemStock

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/item-stock

# ItemStock

Displays product stock status and availability as color-coded badges. Reads from a `ProductInventory` object and renders up to two inline badges: an availability indicator (available / not available) and a stock level indicator (in stock / low stock / out of stock) with the exact quantity.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Default (both badges visible)

```tsx


<ItemStock inventory={product.inventory} />
```

### Availability badge only (hide stock quantity)

```tsx
<ItemStock
  inventory={product.inventory}
  showStock={false}
/>
```

### Stock quantity only (hide availability badge)

```tsx
<ItemStock
  inventory={product.inventory}
  showAvailability={false}
/>
```

### With custom labels (localization)

```tsx
<ItemStock
  inventory={product.inventory}
  labels={{
    inStock: 'Op voorraad',
    outOfStock: 'Niet op voorraad',
    lowStock: 'Beperkte voorraad',
    available: 'Beschikbaar',
    notAvailable: 'Niet beschikbaar',
    pieces: 'stuks',
  }}
/>
```

### Inside a product card with extra styling

```tsx
<ItemStock
  inventory={product.inventory}
  className="mt-2"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

A standalone implementation that reads from the same `ProductInventory` shape:

```tsx


function SimpleItemStock({ inventory }: { inventory: ProductInventory }) {
  const qty = inventory?.totalQuantity;

  if (qty === undefined || qty === null) return null;

  const isAvailable = qty > 0;
  const statusLabel =
    qty === 0 ? 'Out of stock' : qty <= 5 ? 'Low stock' : 'In stock';
  const statusColor =
    qty === 0 ? 'red' : qty <= 5 ? 'orange' : 'green';

  return (
    <div style={{ display: 'flex', gap: '8px', alignItems: 'center' }}>
      {/* Availability */}
      <span style={{ color: isAvailable ? 'green' : 'red' }}>
        {isAvailable ? 'Available' : 'Not available'}
      </span>

      {/* Stock level */}
      <span style={{ color: statusColor }}>
        {statusLabel}
        {qty > 0 && ` (${qty} pcs)`}
      </span>
    </div>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `inventory` | `ProductInventory` | Yes | -- | Product inventory object that drives all stock calculations and display logic |

### Display toggles

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showAvailability` | `boolean` | `true` | Show the availability badge (Available / Not available) |
| `showStock` | `boolean` | `true` | Show the stock level badge with quantity |

### Customization

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `labels` | `Record<string, string>` | See labels table below | Override any display label |
| `className` | `string` | `''` | Extra CSS class applied to the root wrapper element |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function itemStock(inventory: ProductInventory): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `inventory` | `ProductInventory` | **required** | Product inventory object |
| `showAvailability` | `boolean` | `true` | Show availability badge |
| `showStock` | `boolean` | `true` | Show stock level badge |

### UI-only props

The following props control display only and have no SDK equivalent: `labels`, `className`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

All text labels can be overridden via the `labels` prop. Pass a `Record<string, string>` with any of these keys:

| Key | Default value | Used in |
|-----|---------------|---------|
| `inStock` | `In stock` | Stock badge when quantity > 5 |
| `outOfStock` | `Out of stock` | Stock badge when quantity is 0 |
| `lowStock` | `Low stock` | Stock badge when quantity is 1--5 |
| `available` | `Available` | Availability badge when quantity > 0 |
| `notAvailable` | `Not available` | Availability badge when quantity is 0 |
| `pieces` | `pcs` | Unit label shown in parentheses after the stock quantity |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  inStock: 'In stock',
  outOfStock: 'Out of stock',
  lowStock: 'Low stock',
  available: 'Available',
  notAvailable: 'Not available',
  pieces: 'pcs',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Rendering guard

The component renders nothing when:
- The `inventory` prop is falsy (null or undefined)
- `totalQuantity` is undefined or null (interpreted as "no inventory data available")

When `totalQuantity` is 0 or a positive number, the component renders.

### Stock level classification

The stock quantity determines the status label and color coding:

| Quantity | Status label | Badge colors |
|----------|-------------|--------------|
| > 5 | In stock | Green text, green background, green border |
| 1 -- 5 | Low stock | Amber text, amber background, amber border |
| 0 | Out of stock | Red text, red background, red border |

When the quantity is greater than 0, the exact count is shown in parentheses after the status label (e.g., "In stock (42 pcs)"). When the quantity is 0, only the "Out of stock" label is shown without a count.

### Availability display

The availability badge shows a simple binary state:

| Condition | Label | Dot color | Badge colors |
|-----------|-------|-----------|--------------|
| Quantity > 0 | Available | Green dot | Green text, green background, green border |
| Quantity = 0 | Not available | Red dot | Red text, red background, red border |

The availability dot is a small circular indicator rendered inline before the label text.

### Layout

The component renders as a horizontal flex container with `flex-wrap` enabled. The two badges (availability and stock) sit side by side and wrap to the next line on narrow containers. Each badge is a rounded pill (`rounded-full`) with a small border, compact padding, and 11px font size.

## SDK Services

ItemStock is a display-only component -- it does not call any SDK services itself. It receives a `ProductInventory` object as a prop and reads the following field:

### ProductInventory fields used

| Field | Type | Purpose |
|-------|------|---------|
| `inventory.totalQuantity` | `number` | The total available stock quantity across all warehouses. Drives both the availability check and the stock level classification. |

The `ProductInventory` type is imported from `propeller-sdk-v2`. When fetching product data, ensure the `inventory` field with `totalQuantity` is included in your query.

## GraphQL Queries and Mutations

To fetch inventory data alongside a product:

```graphql
query Product($productId: Int!) {
  product(id: $productId) {
    productId
    name {
      value
    }
    inventory {
      totalQuantity
    }
  }
}
```

Or when fetching products within a category:

```graphql
query Products($categoryId: Int!, $offset: Int, $limit: Int) {
  products(categoryId: $categoryId, offset: $offset, limit: $limit) {
    items {
      productId
      name {
        value
      }
      inventory {
        totalQuantity
      }
    }
  }
}
```

---

## ItemsOverview

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/items-overview

# ItemsOverview

A read-only cart items display component that renders each line item as a compact row with optional image, SKU, quantity, availability, and price. Supports normal products, cluster items with child variants, and bundle items with leader/non-leader breakdown.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

```tsx


// Minimal — show all cart items with default settings (all columns visible)
<ItemsOverview cart={cart} />

// Checkout sidebar — read-only, no clicking, no availability
<ItemsOverview
  cart={cart}
  title="Order Summary"
  showAvailability={false}
  itemNameClickable={false}
/>

// Clickable items with navigation to product pages
<ItemsOverview
  cart={cart}
  onCartItemNameClick={(item) => router.push(`/product/${item.product?.slug}`)}
/>

// Minimal display — images and prices only, no SKU or stock info
<ItemsOverview
  cart={cart}
  showSku={false}
  showAvailability={false}
  showQuantity={false}
/>

// Custom price formatting and labels (e.g., for a non-EUR store)
<ItemsOverview
  cart={cart}
  formatPrice={(price) => `$${price.toFixed(2)}`}
  labels={{
    quantity: 'Amount:',
    inStock: 'Available',
    outOfStock: 'Unavailable',
    noItems: 'Your cart is empty.',
  }}
/>

// Styled container with custom CSS class
<ItemsOverview
  cart={cart}
  itemsOverviewContainerClass="bg-white rounded-lg p-4 shadow-sm"
  title="Your Items"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom items overview component, you need a `Cart` object and access to its `items` array. Here is the minimal structure:

```tsx
interface CustomItemsOverviewProps {
  cart: Cart;
}

function CustomItemsOverview({ cart }: CustomItemsOverviewProps) {
  const items = (cart as any)?.items || [];

  return (
    <div>
      {items.map((item: CartMainItem) => {
        const name = item.product?.names?.[0]?.value || 'Product';
        const price = (item.price || 0) * (item.quantity || 1);
        const imageUrl = item.product?.media?.images?.items?.[0]?.imageVariants?.[0]?.url;
        const isBundle = !!item.bundle;

        return (
          <div key={item.itemId}>
            {isBundle ? (
              <BundleRow item={item} />
            ) : (
              <div>
                <span>{name}</span>
                <span>{price.toFixed(2)}</span>
              </div>
            )}
          </div>
        );
      })}
    </div>
  );
}
```

Key considerations:

- **Cast `cart` to `any`** to access `items` — the SDK `Cart` type may not expose it directly.
- **Check `item.bundle`** to distinguish bundle items from normal/cluster items.
- **Check `item.childItems`** (array length > 0) to distinguish cluster items from simple products.
- **Bundle leader identification** uses `Enums.YesNo.Y` from `propeller-sdk-v2`: `bundle.items.find(bi => bi.isLeader === Enums.YesNo.Y)`.
- **Image URLs** should be validated (check they start with "http") before rendering in an `<img>` tag.
- **Stock availability** comes from `item.product.inventory.totalQuantity` — a value of `0`, `null`, or `undefined` means out of stock.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `cart` | `Cart` | Shopping cart object. Items are read from `cart.items`. |

### Display Toggles

All default to `true`. Set to `false` to hide the corresponding column.

| Prop | Type | Default | Description |
|---|---|---|---|
| `showImage` | `boolean` | `true` | Show a 64x64 product thumbnail. Falls back to an SVG placeholder when no image URL is available. |
| `showSku` | `boolean` | `true` | Show the product SKU below the item name. |
| `showQuantity` | `boolean` | `true` | Show the item quantity (e.g., "Qty: 3"). |
| `showAvailability` | `boolean` | `true` | Show stock status text. Green for in-stock, red for out-of-stock. |
| `showPrice` | `boolean` | `true` | Show the line total price (unit price multiplied by quantity). |

### Interaction

| Prop | Type | Default | Description |
|---|---|---|---|
| `itemNameClickable` | `boolean` | `true` | When `true`, item names render as clickable text with hover styling. |
| `onCartItemNameClick` | `(item: CartMainItem) => void` | `undefined` | Callback fired when a clickable item name is clicked. Receives the full `CartMainItem`. Only fires when `itemNameClickable` is `true`. |

### Customization

| Prop | Type | Default | Description |
|---|---|---|---|
| `title` | `string` | `undefined` | Optional heading rendered above the items list as an `<h2>`. |
| `itemsOverviewContainerClass` | `string` | `'cart-items-overview'` | CSS class applied to the outermost container `<div>`. |
| `formatPrice` | `(price: number) => string` | Internal formatter | Custom price formatting function. The default formats as EUR with two decimals (e.g., "EUR 12.50"). |
| `labels` | `Record<string, string>` | `{}` | Override default label strings. Supported keys: `quantity` (default "Qty:"), `inStock` (default "In stock"), `outOfStock` (default "Out of stock"), `noItems` (default "No items in cart."). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function itemsOverview(cart: Cart): void
```

### Options

| Field | Type | Default | Maps to |
|---|---|---|---|
| `cart` | `Cart` | **required** | Shopping cart object |
| `showImage` | `boolean` | `true` | Show product thumbnail |
| `showSku` | `boolean` | `true` | Show product SKU |
| `showQuantity` | `boolean` | `true` | Show item quantity |
| `showAvailability` | `boolean` | `true` | Show stock status |
| `showPrice` | `boolean` | `true` | Show line total price |

### Cart resolution

The component reads items from `cart.items`. Each `CartMainItem` provides:

| Field | Purpose |
|---|---|
| `item.itemId` | Unique key for each row |
| `item.product.names[0].value` | Item name (fallback: "Product") |
| `item.product.sku` | Product SKU |
| `item.product.media.images.items[0].imageVariants[0].url` | Thumbnail URL |
| `item.product.inventory.totalQuantity` | Stock status |
| `item.price` | Unit price |
| `item.quantity` | Quantity |
| `item.childItems` | Cluster variant children |
| `item.bundle` | Bundle data (when present, item is a bundle) |

### Callbacks

| Callback | Signature | Description |
|---|---|---|
| `onCartItemNameClick` | `(item: CartMainItem) => void` | Fired when a clickable item name is clicked |

### UI-only props

The following props control display only: `title`, `itemsOverviewContainerClass`, `formatPrice`, `labels`, `itemNameClickable`, `className`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `quantity` | `"Qty:"` | Quantity label prefix |
| `inStock` | `"In stock"` | Stock status for available items |
| `outOfStock` | `"Out of stock"` | Stock status for unavailable items |
| `noItems` | `"No items in cart."` | Empty state message |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  quantity: 'Qty:',
  inStock: 'In stock',
  outOfStock: 'Out of stock',
  noItems: 'No items in cart.',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Three item types**: The component handles three item shapes transparently. If `item.bundle` is present, it renders as a bundle with leader/non-leader breakdown. If `item.childItems` has entries, it renders as a cluster item with nested children. Otherwise, it renders as a standard line item.
- **Image fallback**: When no valid image URL is found (missing, empty, or not starting with "http"), an inline SVG placeholder icon is shown instead.
- **Price calculation**: Line total is computed as `item.price * item.quantity`. For bundles, `bundle.price.net` and each `bundleItem.price.net` are displayed directly without multiplication.
- **Stock status**: Availability text is color-coded: green (`text-green-600`) for in-stock items, red (`text-red-500`) for out-of-stock. Only shown for non-bundle items.
- **Empty state**: When `cart.items` is empty, a styled italic message is displayed using the `noItems` label.
- **Clickable names**: When `itemNameClickable` is `true` and `onCartItemNameClick` is provided, item names get `cursor-pointer` styling with a hover color transition. Bundle names are never clickable.
- **Bundle layout**: Bundles display the bundle name and total price at the top, followed by an indented list (left-bordered) showing the leader item (styled slightly bolder) and all non-leader items below it.
- **Cluster layout**: Cluster items display the parent product name and price, followed by an indented list of child variant items showing their names and individual `totalSum` values.

## SDK Services and Cart Fields

This component is read-only and does not call any SDK services. It receives a `Cart` object via props and reads the following fields:

### From `Cart`

| Field | Usage |
|---|---|
| `cart.items` | Array of `CartMainItem` objects to iterate over. |

### From each `CartMainItem`

| Field | Usage |
|---|---|
| `item.itemId` | Used as the React `key` for each row. |
| `item.product.names[0].value` | Displayed as the item name. Falls back to "Product". |
| `item.product.sku` | Displayed when `showSku` is enabled. |
| `item.product.media.images.items[0].imageVariants[0].url` | Product thumbnail URL. Must start with "http" to be used. |
| `item.product.inventory.totalQuantity` | Determines stock status text and color. `> 0` = in stock, `0` or missing = out of stock. |
| `item.price` | Unit price. Multiplied by `item.quantity` for the line total. |
| `item.quantity` | Displayed in the quantity label and used for price calculation. |
| `item.childItems` | Array of `CartBaseItem` for cluster variant children. Each child displays its `product.names[0].value` and `totalSum`. |
| `item.bundle` | When present, the item renders as a bundle instead of a normal product. |

### From `item.bundle` (Bundle Items)

| Field | Usage |
|---|---|
| `bundle.name` | Displayed as the bundle title. Falls back to "Bundle". |
| `bundle.price.net` | Bundle-level price, shown next to the bundle name. |
| `bundle.items` | Array of `BundleItem` objects. Split into leader and non-leaders. |
| `bundle.items[].isLeader` | Compared against `Enums.YesNo.Y` to identify the bundle leader. |
| `bundle.items[].product.names[0].value` | Name of each bundle component product. |
| `bundle.items[].price.net` | Price of each bundle component. |

---

## PriceToggle

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/price-toggle

# PriceToggle

A lightweight UI toggle that lets users switch between displaying prices including VAT or excluding VAT. The component does not perform price calculations — it broadcasts the user's preference so other components can adjust which price they display.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic toggle in the header

```tsx


function Header() {
  return (
    <PriceToggle
      inclExclVatSwitched={(on) => {
        localStorage.setItem('price_include_tax', String(on));
      }}
    />
  );
}
```

### With a custom label and initial state

```tsx
<PriceToggle
  label="Show prices:"
  initialState={false}
  inclExclVatSwitched={(on) => {
    localStorage.setItem('price_include_tax', String(on));
  }}
/>
```

### Reading the persisted value on mount

```tsx
function HeaderToggle() {
  const stored = typeof window !== 'undefined'
    ? localStorage.getItem('price_include_tax') !== 'false'
    : true;

  return (
    <PriceToggle
      initialState={stored}
      inclExclVatSwitched={(on) => {
        localStorage.setItem('price_include_tax', String(on));
      }}
    />
  );
}
```

### Styled with extra class

```tsx
<PriceToggle
  className="bg-gray-100 rounded px-2 py-1"
  inclExclVatSwitched={(on) => {
    localStorage.setItem('price_include_tax', String(on));
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Custom VAT toggle

If you need a toggle with different styling or behavior, replicate these two essentials:

1. **Persist to localStorage** under the key `price_include_tax`
2. **Dispatch the custom event** `priceToggleChanged` with the boolean value as `detail`

```ts
// pseudo-code

// Read the current value from localStorage (default to true)
function readIncludeTax(): boolean {
  if (typeof window === 'undefined') return true;
  return localStorage.getItem('price_include_tax') !== 'false';
}

// Toggle the VAT preference
function toggleVat(currentValue: boolean): void {
  const next = !currentValue;
  localStorage.setItem('price_include_tax', String(next));
  window.dispatchEvent(new CustomEvent('priceToggleChanged', { detail: next }));
}

// Render a toggle button that displays "Incl. VAT" or "Excl. VAT"
// based on the current value. On click, call `toggleVat(currentValue)`.
```

### Listening for the toggle in another component

Any component that displays prices should listen for the `priceToggleChanged` event and read the initial value from localStorage on mount:

```ts
// pseudo-code

// On component initialization:
let includeTax = true; // default must be true to avoid SSR mismatches
const stored = localStorage.getItem('price_include_tax');
if (stored !== null) {
  includeTax = (stored !== 'false');
}

// Register an event listener for live updates:
function onToggle(e: Event) {
  includeTax = (e as CustomEvent).detail;
  // Re-render your component with the new value
}
window.addEventListener('priceToggleChanged', onToggle);

// On component teardown, remove the listener:
window.removeEventListener('priceToggleChanged', onToggle);

// To display the correct price:
// price.net = incl. VAT, price.gross = excl. VAT
const displayPrice = includeTax ? price.net : price.gross;
const label = includeTax ? 'incl. VAT' : 'excl. VAT';
```

Key points for the listener pattern:

- Initialize `includeTax` to `true` (not `false`) to match the default and avoid SSR/hydration mismatches.
- If an explicit `includeTax` prop is passed, let it take precedence over the localStorage/event value.
- Always clean up the event listener when the component is destroyed.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Display

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `label` | `string` | No | `'Prices:'` | Label text shown beside the toggle. Hidden on small screens (`hidden sm:inline`). |
| `className` | `string` | No | `''` | Extra CSS class applied to the root element. |

### State & Callbacks

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `initialState` | `boolean` | No | `true` | Initial toggle position. `true` = incl. VAT, `false` = excl. VAT. |
| `inclExclVatSwitched` | `(on: boolean) => void` | Yes | — | Callback fired when the toggle is switched. Receives the new state. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function createPriceToggle(options?: PriceToggleOptions): void
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `label` | `string` | `'Prices:'` | Label text beside the toggle |
| `initialState` | `boolean` | `true` | Starting toggle position (`true` = incl. VAT) |
| `onToggle` | `(on: boolean) => void` | — | Callback when the toggle is switched |

### Callbacks

| Callback | Signature | Description |
|----------|-----------|-------------|
| `onToggle` | `(on: boolean) => void` | Fired when the toggle is switched. Receives the new state. |

### UI-only props

The following props are purely visual and have no SDK equivalent: `label`, `className`.

</TabItem>
</Tabs>

---

## Behavior

### localStorage persistence

The toggle value is persisted under the localStorage key `price_include_tax` as a string (`'true'` or `'false'`). The parent component is responsible for writing to localStorage inside the `inclExclVatSwitched` callback. Listening components read this key on mount to initialize their state.

### Custom event dispatch

Every time the toggle is switched, the component dispatches a global custom event:

```ts
window.dispatchEvent(new CustomEvent('priceToggleChanged', { detail: newValue }));
```

`detail` is a boolean: `true` for incl. VAT, `false` for excl. VAT. This event fires automatically — the parent does not need to dispatch it.

### Default state

The default state is `true` (incl. VAT). This matches the initialization value used by all listening components, which prevents hydration mismatches. If you override `initialState` to `false`, make sure localStorage already contains `'false'` before the page renders, or listening components will briefly show incl. VAT prices until they receive the event.

### Rendering

The toggle renders as a `<button>` with `role="switch"` and `aria-checked` for accessibility. It displays either "Incl. VAT" or "Excl. VAT" as text. The label is hidden on screens smaller than the `sm` breakpoint.

## SDK Services

PriceToggle does not call any SDK services directly. It is a pure UI control. However, it dispatches a `priceToggleChanged` custom event that other components listen for to decide which SDK price field to display.

### SDK price mapping

The Propeller SDK uses inverted naming for price fields:

| SDK field | Actual meaning |
|-----------|----------------|
| `price.net` | Price **including** VAT |
| `price.gross` | Price **excluding** VAT |

When the toggle is **on** (`true`), components should display `price.net` (incl. VAT) as the primary price. When the toggle is **off** (`false`), components should display `price.gross` (excl. VAT).

### Components that listen for the toggle

| Component | How it listens |
|-----------|---------------|
| ProductCard | Internal `priceToggleChanged` event listener + `_includeTax` state |
| ClusterCard | Internal `priceToggleChanged` event listener + `_includeTax` state |
| ProductPrice | Internal `priceToggleChanged` event listener + `_includeTax` state |
| ProductBulkPrices | Internal `priceToggleChanged` event listener + `_includeTax` state |
| FavoriteListItem | Internal `priceToggleChanged` event listener + `_includeTax` state |
| Cluster detail page | Inline `useState` + `useEffect` listener |

---

## ProductBulkPrices

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-bulk-prices

# ProductBulkPrices

Displays volume/tiered pricing for a product in a table format, showing quantity ranges alongside their corresponding unit prices.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Minimal

```tsx
<ProductBulkPrices bulkPrices={product?.bulkPrices || []} />
```

### With VAT explicitly set

```tsx
<ProductBulkPrices
  bulkPrices={product?.bulkPrices || []}
  includeTax={false}
/>
```

### Without title

```tsx
<ProductBulkPrices
  bulkPrices={product?.bulkPrices || []}
  labels={{ title: '' }}
/>
```

### Semi-closed portal (hidden for anonymous users)

```tsx
<ProductBulkPrices
  bulkPrices={product?.bulkPrices || []}
  portalMode="semi-closed"
  user={authState.user}
/>
```

### Fully customized labels

```tsx
<ProductBulkPrices
  bulkPrices={product?.bulkPrices || []}
  portalMode="open"
  user={authState.user}
  className="my-4"
  labels={{
    title: 'Staffelprijzen',
    quantityFrom: 'Aantal vanaf',
    price: 'Prijs',
    inclTax: 'incl. BTW',
    exclTax: 'excl. BTW',
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom bulk-prices display:

1. **Obtain bulk prices** -- they live on `product.bulkPrices` (an array of `ProductPrice` objects) returned by `ProductService.getProduct()`. Include `userBulkPriceProductInput` for user-specific tiers.

2. **Choose the price field** -- use `tier.net` for VAT-inclusive prices and `tier.gross` for VAT-exclusive prices. To support the global PriceToggle, read `localStorage.getItem('price_include_tax')` and listen for `priceToggleChanged` events.

3. **Compute quantity ranges** -- iterate over the sorted tiers. For each tier, read `tier.discount?.quantityFrom` (or fall back to `tier.quantity`). The upper bound of a range is one less than the next tier's threshold. The final tier has no upper bound.

4. **Handle empty state** -- if the array is empty or absent, render nothing.

5. **Handle semi-closed portal** -- if your store uses `portalMode: 'semi-closed'`, check for an authenticated `user` before rendering pricing.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|------|------|-------------|
| bulkPrices | `ProductPrice[]` | Bulk price tiers from `product.bulkPrices` |

### Pricing

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| includeTax | `boolean` | `true` (or localStorage) | When `true`, shows `tier.net` (incl. VAT). When `false`, shows `tier.gross` (excl. VAT). If omitted, defers to the PriceToggle state |
| taxZone | `string` | `'NL'` | Tax zone code passed to the product query |

### Visibility

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| portalMode | `string` | `'open'` | Set to `'semi-closed'` to hide the component for anonymous users |
| user | `Contact \| Customer \| null` | `null` | Authenticated user object. Required when `portalMode` is `'semi-closed'` |

### Appearance

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| labels | `Record<string, string>` | `{}` | Override any UI string (see Labels section below) |
| className | `string` | `''` | Extra CSS class applied to the root element |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderBulkPrices(bulkPrices: ProductPrice[], options?: BulkPriceOptions): void
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `bulkPrices` | `ProductPrice[]` | — | `bulkPrices` prop |
| `includeTax` | `boolean` | `true` | `includeTax` prop |
| `taxZone` | `string` | `'NL'` | `taxZone` prop |
| `portalMode` | `string` | `'open'` | `portalMode` prop |
| `user` | `Contact \| Customer \| null` | `null` | `user` prop |

### UI-only props

The following props are purely visual and have no SDK equivalent: `labels`, `className`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|-----|---------|-------------|
| `title` | `Volume pricing` | Table heading. Set to `''` to hide it entirely |
| `quantityFrom` | `Qty from` | Column header for the quantity range |
| `price` | `Price` | Column header for the unit price |
| `inclTax` | `incl. VAT` | Annotation shown when prices include tax |
| `exclTax` | `excl. VAT` | Annotation shown when prices exclude tax |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  title: 'Volume pricing',
  quantityFrom: 'Qty from',
  price: 'Price',
  inclTax: 'incl. VAT',
  exclTax: 'excl. VAT',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Price toggle (VAT switch)

The component integrates with the global PriceToggle mechanism:

- On mount it reads `localStorage.getItem('price_include_tax')` to determine the initial VAT mode (default: `true`, meaning prices include VAT).
- It listens for the `priceToggleChanged` custom event. When the user flips the toggle elsewhere on the page, this component re-renders with the updated mode.
- The `includeTax` prop, when explicitly passed, takes precedence over the localStorage / event-driven value.
- The price column header dynamically shows "(incl. VAT)" or "(excl. VAT)" to reflect the active mode.

### Tier pricing display

Quantity ranges are computed automatically from adjacent tiers using `discount.quantityFrom` (falling back to `tier.quantity`):

| Tiers (quantityFrom) | Displayed ranges |
|-----------------------|------------------|
| 10, 100 | `10--99`, `100+` |
| 1, 5, 25 | `1--4`, `5--24`, `25+` |
| 50 (single tier) | `50+` |

Each tier's upper bound is one less than the next tier's `quantityFrom`. The last tier always displays with a `+` suffix.

Prices are formatted as EUR with two decimal places (e.g., `EUR 12.50`).

### Visibility rules

- **No bulk prices**: The component renders nothing.
- **Semi-closed portal + no user**: The component is hidden. Pass a `user` object to make it visible.

## SDK Services

ProductBulkPrices is a display-only component -- it does not call any SDK service itself. It receives data that was already fetched as part of a product query.

### Product fields consumed

The component reads from `ProductPrice` objects (the items inside `product.bulkPrices`):

| Field | Type | Usage |
|-------|------|-------|
| `net` | `number` | Unit price including VAT. Displayed when `includeTax` is `true` |
| `gross` | `number` | Unit price excluding VAT. Displayed when `includeTax` is `false` |
| `quantity` | `number` | Fallback quantity threshold when `discount.quantityFrom` is absent |
| `discount.quantityFrom` | `number` | Primary quantity threshold used to compute the range label |

### Fetching bulk prices

Bulk prices are returned as part of the product query. For correct per-user quantity thresholds, pass `userBulkPriceProductInput`:

```tsx
service.getProduct({
  productId: 123,
  userBulkPriceProductInput: {
    taxZone: 'NL',
    companyId: user?.company?.companyId,
    contactId: user?.contactId,
  },
});
```

Without `userBulkPriceProductInput`, the API returns default quantity values (typically `1` for every tier).

---

## ProductBundles

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-bundles

# ProductBundles

Displays product bundles (combo deals) for a given product. Each bundle shows its constituent items with images and prices, a total bundle price with discount badge, and an "Add to cart" button. After a successful add-to-cart, the component can show either an inline toast notification or a confirmation modal with "Continue shopping" and "Proceed to checkout" options.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage with external cart handling

```tsx


<ProductBundles
  graphqlClient={graphqlClient}
  productId={12345}
  language="NL"
  taxZone="NL"
  onAddBundleToCart={(bundleId, quantity) => {
    cartService.addBundleToCart({
      id: cartId,
      input: { bundleId, quantity },
      language: 'NL',
      imageSearchFilters: config.imageSearchFiltersGrid,
      imageVariantFilters: config.imageVariantFiltersSmall,
    }).then(updatedCart => saveCart(updatedCart));
  }}
/>
```

### Self-contained with cart creation and confirmation modal

```tsx
<ProductBundles
  graphqlClient={graphqlClient}
  productId={12345}
  language="NL"
  taxZone="NL"
  cartId={cart?.cartId}
  createCart={true}
  user={authState.user}
  configuration={config}
  showModal={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterBundleAddToCart={(updatedCart) => saveCart(updatedCart)}
  onProceedToCheckout={() => router.push('/checkout')}
/>
```

### Semi-closed portal (prices hidden for anonymous users)

```tsx
<ProductBundles
  graphqlClient={graphqlClient}
  productId={12345}
  language="NL"
  taxZone="NL"
  portalMode="semi-closed"
  user={authState.user}
  cartId={cart?.cartId}
  afterBundleAddToCart={(updatedCart) => saveCart(updatedCart)}
  labels={{
    loginToSeePrices: 'Please log in to view prices and order',
  }}
/>
```

### Compact layout with custom labels

```tsx
<ProductBundles
  graphqlClient={graphqlClient}
  productId={12345}
  language="EN"
  taxZone="NL"
  layout="compact"
  includeTax={false}
  cartId={cart?.cartId}
  afterBundleAddToCart={(updatedCart) => saveCart(updatedCart)}
  labels={{
    title: 'Bundle offer',
    addToCart: 'Add bundle to cart',
    youSave: 'You save',
    condition_ALL: 'Discount on all items',
    condition_EP: 'Discount on extra products',
    adding: 'Adding...',
    addedToCart: 'added to cart',
  }}
/>
```

### With before/after lifecycle callbacks

```tsx
<ProductBundles
  graphqlClient={graphqlClient}
  productId={12345}
  language="NL"
  taxZone="NL"
  cartId={cart?.cartId}
  beforeBundleAddToCart={(bundleId, quantity) => {
    // Return false to cancel the add-to-cart
    if (!acceptedTerms) return false;
    trackAnalytics('bundle_add', { bundleId });
    return true;
  }}
  afterBundleAddToCart={(updatedCart, bundle) => {
    saveCart(updatedCart);
    toast.success(`${bundle?.name} added!`);
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom product bundles UI without using the component, set up the SDK services and use the following operations.

### Service setup

```ts

  BundleService,
  CartService,
  Bundle,
  BundleItem,
  BundleQueryVariables,
  CartAddBundleVariables,
  Enums,
} from 'propeller-sdk-v2';

const bundleService = new BundleService(graphqlClient);
const cartService = new CartService(graphqlClient);
```

### Fetch bundles

```ts
// pseudo-code: call on initialization and when productId changes
async function fetchBundles(productId: number, language = 'NL', taxZone = 'NL'): Promise<Bundle[]> {
  const variables: BundleQueryVariables = {
    input: {
      productIds: [productId],
      taxZone,
      page: 1,
      offset: 20,
    },
    language,
  };
  const result = await bundleService.getBundles(variables);
  return result?.items || [];
}
```

### Price helper functions

```ts
// Prices follow the Propeller SDK convention: net = incl. VAT, gross = excl. VAT
function getPrice(bundle: Bundle, includeTax: boolean): number {
  return includeTax ? bundle.price?.net || 0 : bundle.price?.gross || 0;
}

function getOriginalPrice(bundle: Bundle, includeTax: boolean): number {
  return includeTax ? bundle.price?.originalNet || 0 : bundle.price?.originalGross || 0;
}

function getItemPrice(item: BundleItem, includeTax: boolean): number {
  return includeTax ? item.price?.net || 0 : item.price?.gross || 0;
}

function formatPrice(value: number): string {
  return `\u20AC${value.toFixed(2)}`;
}
```

### Add bundle to cart

```ts
async function addBundleToCart(cartId: string, bundle: Bundle, language = 'NL') {
  // pseudo-code: guard against double-submission with a loading flag
  const variables: CartAddBundleVariables = {
    id: cartId,
    input: { bundleId: bundle.id, quantity: 1 },
    language,
  };
  const updatedCart = await cartService.addBundleToCart(variables);
  // pseudo-code: update cart state, show success notification
  return updatedCart;
}
```

### UI structure

For each bundle, render a card showing: the bundle name (fall back to "Combo deal"), an optional description, the bundle condition text (`ALL` = "Discount on all items", `EP` = "Discount on extra items"), the individual bundle items with product names and prices, the total bundle price with a strikethrough original price when a discount applies, a savings badge showing the difference, and an "Add to cart" button with a loading/disabled state to prevent double-submission. If no bundles exist for the product, render nothing.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | Yes | -- | Propeller SDK GraphQL client instance |
| `productId` | `number` | Yes | -- | Product ID whose bundles are fetched |
| `language` | `string` | Yes | -- | Language code (e.g. `'NL'`, `'EN'`) |
| `taxZone` | `string` | Yes | -- | Tax zone for pricing (e.g. `'NL'`) |
| `configuration` | `any` | No | -- | App config object; must include `imageSearchFiltersGrid`, `imageVariantFiltersSmall`, and `imageVariantFiltersMedium` when using self-contained cart mode |

### Cart integration

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `cartId` | `string` | No | -- | Existing cart ID. Required when `onAddBundleToCart` is not provided and `createCart` is false |
| `createCart` | `boolean` | No | `false` | When true, a new cart is created automatically if no `cartId` is available |
| `onCartCreated` | `(cart: Cart) => void` | No | -- | Called when the component creates a new cart internally. Use this to persist the cart to your app state |
| `onAddBundleToCart` | `(bundleId: string, qty: number) => void` | No | -- | External handler that fully replaces the built-in add-to-cart logic. When provided, the component delegates all cart operations to this callback |
| `beforeBundleAddToCart` | `(bundleId: string, qty: number) => boolean` | No | -- | Called before the internal add-to-cart. Return `false` to cancel |
| `afterBundleAddToCart` | `(cart: Cart, bundle?: Bundle) => void` | No | -- | Called after a successful internal add-to-cart with the updated cart |

### Pricing and visibility

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `includeTax` | `boolean` | No | `true` (from localStorage PriceToggle) | When true, shows net prices (incl. VAT). When false, shows gross prices (excl. VAT). Overrides the PriceToggle localStorage value when explicitly set |
| `portalMode` | `string` | No | `'open'` | Set to `'semi-closed'` to hide all prices and the add-to-cart button for anonymous (logged-out) users |
| `user` | `Contact \| Customer \| null` | No | `null` | Authenticated user object. Used for semi-closed visibility checks and for setting contact/customer on new carts |
| `stockValidation` | `boolean` | No | `false` | When true, validates stock availability before adding to cart |

### Display

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `layout` | `'vertical' \| 'horizontal' \| 'compact'` | No | `'horizontal'` | `horizontal` -- items side-by-side with `+` separators; `vertical` -- items stacked; `compact` -- condensed view, hides individual items |
| `showIndividualItems` | `boolean` | No | `true` | Show the individual products inside each bundle card |
| `className` | `string` | No | `'mb-12'` | CSS class applied to the root wrapper element |

### Modal and feedback

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `showModal` | `boolean` | No | `false` | When true, shows a confirmation modal after add-to-cart instead of the inline toast |
| `onProceedToCheckout` | `() => void` | No | -- | Called when the user clicks "Proceed to checkout" in the modal |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchAndRenderBundles(
  graphqlClient: GraphQLClient,
  productId: number,
  options?: BundleOptions
): Promise<void>
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `language` | `string` | `'NL'` | `language` prop |
| `taxZone` | `string` | `'NL'` | `taxZone` prop |
| `includeTax` | `boolean` | `true` | `includeTax` prop |
| `layout` | `string` | `'horizontal'` | `layout` prop |
| `showIndividualItems` | `boolean` | `true` | `showIndividualItems` prop |
| `portalMode` | `string` | `'open'` | `portalMode` prop |
| `stockValidation` | `boolean` | `false` | `stockValidation` prop |

### Cart resolution

When using self-contained cart mode, the component resolves a cart ID through this flow:

1. Uses `props.cartId` if provided
2. Otherwise searches for existing carts via `CartService.getCarts(searchInput)`
3. If no cart found and `createCart` is true, creates one via `CartService.startCart()`
4. After creation, calls `CartService.updateCartAddress()` for default addresses
5. Fires `onCartCreated` so the parent can persist the cart

### Callbacks

| Callback | Signature | Description |
|----------|-----------|-------------|
| `onCartCreated` | `(cart: Cart) => void` | New cart was created internally |
| `onAddBundleToCart` | `(bundleId: string, qty: number) => void` | External handler replacing built-in cart logic |
| `beforeBundleAddToCart` | `(bundleId: string, qty: number) => boolean` | Return `false` to cancel |
| `afterBundleAddToCart` | `(cart: Cart, bundle?: Bundle) => void` | Called after successful add |
| `onProceedToCheckout` | `() => void` | User clicked checkout in modal |

### UI-only props

The following props are purely visual and have no SDK equivalent: `labels`, `className`, `showModal`.

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Where it appears |
|-----|---------|------------------|
| `title` | `'Combo deal'` | Fallback bundle name |
| `addToCart` | `'In cart'` | Add-to-cart button |
| `adding` | `'Adding...'` | Button text while request is in flight |
| `addedToCart` | `'added to cart'` | Toast message suffix |
| `youSave` | `'Your savings:'` | Discount badge prefix |
| `leaderItem` | `'Main product'` | Badge for the leader item |
| `condition_ALL` | `'Discount on all items'` | Shown when bundle condition is `ALL` |
| `condition_EP` | `'Discount on extra items'` | Shown when bundle condition is `EP` |
| `inclTax` | `'incl. VAT'` | Price suffix |
| `exclTax` | `'excl. VAT'` | Price suffix |
| `loginToSeePrices` | `'Log in to see prices and add to cart'` | Semi-closed mode message |
| `modalTitle` | `'Added to cart'` | Modal header text |
| `continueShopping` | `'Continue shopping'` | Modal button |
| `proceedToCheckout` | `'Proceed to checkout'` | Modal button |
| `noCartId` | `'No cart ID provided'` | Error toast when no cart is available |
| `quantity` | `'Quantity'` | Modal item detail |
| `errorAdding` | `'Failed to add bundle to cart'` | Error toast on failure |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  title: 'Combo deal',
  addToCart: 'In cart',
  adding: 'Adding...',
  addedToCart: 'added to cart',
  youSave: 'Your savings:',
  leaderItem: 'Main product',
  condition_ALL: 'Discount on all items',
  condition_EP: 'Discount on extra items',
  inclTax: 'incl. VAT',
  exclTax: 'excl. VAT',
  loginToSeePrices: 'Log in to see prices and add to cart',
  modalTitle: 'Added to cart',
  continueShopping: 'Continue shopping',
  proceedToCheckout: 'Proceed to checkout',
  noCartId: 'No cart ID provided',
  quantity: 'Quantity',
  errorAdding: 'Failed to add bundle to cart',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Fetching and rendering

- The component fetches bundles on mount via `BundleService.getBundles()` using the provided `productId`.
- If no bundles exist for the product, the component renders nothing (returns null).
- When `productId` changes, bundles are re-fetched automatically.
- Multiple bundles are rendered as separate cards, each with its own add-to-cart button.

### Bundle items display

- Each bundle card shows its constituent items as product thumbnails with names and individual prices, connected by green `+` separator icons.
- Setting `showIndividualItems=\{false\}` or `layout="compact"` hides the individual items section.
- Items include product images from `product.media.images.items[0].imageVariants[0].url`.

### Pricing and discounts

- Prices follow the Propeller SDK convention: `price.net` = incl. VAT, `price.gross` = excl. VAT.
- Original prices (`originalNet` / `originalGross`) are shown with strikethrough when the bundle has a discount.
- A green discount badge shows the total savings amount (e.g., "Your savings: EUR 15.00").
- The `includeTax` prop overrides the PriceToggle localStorage value. If not passed, the component reads from `localStorage` and listens for the `priceToggleChanged` custom event.

### Bundle conditions

- `ALL` -- discount applies to every item in the bundle.
- `EP` (Extra Products) -- discount applies only to the non-leader items.
- The condition type is displayed as explanatory text below the bundle description.

### Cart integration modes

**External mode** (`onAddBundleToCart` provided): The component calls your callback with `(bundleId, quantity)` and you handle all cart logic yourself.

**Self-contained mode** (`onAddBundleToCart` omitted): The component uses `CartService.addBundleToCart()` internally. It resolves a cart ID from `props.cartId` or its own `activeCartId`. If neither exists and `createCart=\{true\}`, it initializes a cart via this flow:

1. Calls `CartService.getCarts(searchInput)` to search for existing carts for the authenticated user
2. If an existing cart is found, uses that cart ID
3. If no cart exists, calls `CartService.startCart()` to create a new one
4. After creation, calls `CartService.updateCartAddress()` to assign default invoice and delivery addresses from the user profile
5. Fires `onCartCreated` with the new cart so the parent can persist it to CartContext

### Add-to-cart feedback

- **Toast (default)**: A 3-second auto-dismissing notification appears in the top-right corner -- green for success, red for errors.
- **Modal** (`showModal=\{true\}`): A centered overlay shows the added bundle with its image, name, sub-items, and price. Two buttons: "Continue shopping" (closes modal) and "Proceed to checkout" (closes modal + calls `onProceedToCheckout`).

### Semi-closed portal

When `portalMode="semi-closed"` and no `user` is provided, all prices and the add-to-cart button are hidden. A login prompt message is shown instead.

### Hydration

The component uses an internal `isMounted` flag to prevent server/client hydration mismatches. Content only renders after the component has mounted on the client.

## SDK Services

### BundleService

Used to fetch product bundles.

```ts


const bundleService = new BundleService(graphqlClient);

const variables: BundleQueryVariables = {
  input: {
    productIds: [12345],
    taxZone: 'NL',
    page: 1,
    offset: 20,
  },
  language: 'NL',
  imageSearchFilters: { page: 1, offset: 12 },
  imageVariantFilters: {
    transformations: [{
      name: 'medium',
      transformation: { format: 'WEBP', height: 300, width: 300, fit: 'BOUNDS' },
    }],
  },
};

const result = await bundleService.getBundles(variables);
// result.items: Bundle[]
```

### CartService

Used to add a bundle to the cart and (optionally) to create new carts.

```ts


const cartService = new CartService(graphqlClient);

const variables: CartAddBundleVariables = {
  id: 'cart-id-string',
  input: {
    bundleId: 'bundle-id-string',
    quantity: 1,
  },
  language: 'NL',
  imageSearchFilters: { page: 1, offset: 12 },
  imageVariantFilters: {
    transformations: [{
      name: 'cart',
      transformation: { format: 'WEBP', height: 100, width: 100, fit: 'BOUNDS' },
    }],
  },
};

const updatedCart = await cartService.addBundleToCart(variables);
```

### SDK Notes

- **Bundle ID is a string**, not a number. This matches `CartAddBundleInput.bundleId`.
- **BundlePrice fields**: `net` = incl. VAT, `gross` = excl. VAT, `originalNet` / `originalGross` = prices before discount.
- **Cart integration**: `CartService.addBundleToCart()` works correctly with the standard SDK method.

## GraphQL Queries and Mutations

### Fetch bundles for a product

```graphql
query Bundles($input: BundleSearchInput!, $language: String, $imageSearchFilters: ImageSearchInput, $imageVariantFilters: ImageVariantFilterInput) {
  bundles(input: $input) {
    items {
      id
      name
      description
      condition
      price {
        net
        gross
        originalNet
        originalGross
      }
      items {
        productId
        isLeader
        price {
          net
          gross
        }
        product {
          productId
          names(language: $language) {
            value
          }
          media {
            images(input: $imageSearchFilters) {
              items {
                imageVariants(input: $imageVariantFilters) {
                  url
                }
              }
            }
          }
        }
      }
    }
  }
}
```

**Variables:**
```json
{
  "input": {
    "productIds": [12345],
    "taxZone": "NL",
    "page": 1,
    "offset": 20
  },
  "language": "NL"
}
```

### Add bundle to cart

```graphql
mutation CartAddBundle($id: String!, $input: CartAddBundleInput!, $language: String, $imageSearchFilters: ImageSearchInput, $imageVariantFilters: ImageVariantFilterInput) {
  cartAddBundle(id: $id, input: $input) {
    cartId
    total {
      subTotal
      totalNet
      totalGross
    }
    items {
      productId
      quantity
      product {
        names(language: $language) {
          value
        }
        media {
          images(input: $imageSearchFilters) {
            items {
              imageVariants(input: $imageVariantFilters) {
                url
              }
            }
          }
        }
      }
    }
  }
}
```

**Variables:**
```json
{
  "id": "cart-id",
  "input": {
    "bundleId": "bundle-id",
    "quantity": 1
  },
  "language": "NL"
}
```

---

## ProductCard

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-card

# ProductCard

A complete product card component that renders an image with optional badge overlays, product details (name, SKU, manufacturer, short description, price), a favourite toggle, and an embedded **AddToCart** control. Supports both grid and row layouts.

---

## Visual Layout

```
┌─────────────────────────────────┐
│  [badge]          [♡ fav btn]   │  <- image area (aspect-square)
│                                 │
│          [ product image ]      │
│                                 │
├─────────────────────────────────┤
│  SKU-1234                       │  <- SKU (mono)
│  Product name that may wrap     │  <- name (link)
│  Extra attribute value          │  <- textLabels
│  Manufacturer name              │  <- showManufacturer
│  Short description text...      │  <- showShortDescription
│                     € 29.99     │  <- price
├─────────────────────────────────┤
│  [−] [ 1 ] [+]   [  Add  ]     │  <- embedded AddToCart
└─────────────────────────────────┘
```

When `columns={1}`, the card switches to a compact horizontal **row layout** with the image on the left, details in the middle, and price + AddToCart on the right.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Minimal

```tsx




<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  cartId={cart?.cartId}
  configuration={config}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
/>
```

### With SPA Routing and Post-Add Modal

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  cartId={cart?.cartId}
  configuration={config}
  showModal={true}
  onProductClick={(p) => router.push(`/product/${p.productId}`)}
  onProceedToCheckout={() => router.push('/checkout')}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### With Attribute Badge and Text Labels

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  configuration={config}
  imageLabels={['new', 'sale']}
  textLabels={['brand', 'color']}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

Each string in `imageLabels` / `textLabels` is matched against `product.attributes.items[].attributeDescription.name`. Attributes with no matching value are silently omitted.

### With Favourite Toggle

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  configuration={config}
  enableAddFavorite={true}
  onToggleFavorite={(product, isFavorite) => {
    isFavorite
      ? wishlistService.add(product.productId)
      : wishlistService.remove(product.productId);
  }}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### All Display Options with Stock

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  configuration={config}
  showName={true}
  showImage={true}
  showSku={true}
  showManufacturer={true}
  showShortDescription={true}
  showStock={true}
  showAvailability={true}
  stockLabels={{
    inStock: 'In stock',
    outOfStock: 'Out of stock',
    available: 'Available',
    notAvailable: 'Not available',
  }}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Row Layout (Single Column)

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  configuration={config}
  columns={1}
  showStock={true}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

### Fully Localised (Dutch)

```tsx
<ProductCard
  product={product}
  graphqlClient={graphqlClient}
  user={authState.user}
  configuration={config}
  language="NL"
  labels={{
    addToFavorites: 'Toevoegen aan favorieten',
    removeFromFavorites: 'Verwijderen uit favorieten',
  }}
  addToCartLabels={{
    add: 'Toevoegen',
    adding: 'Toevoegen...',
    addedToCart: 'toegevoegd aan winkelwagen',
    outOfStock: 'Onvoldoende voorraad',
    errorAdding: 'Kan product niet toevoegen',
    noCartId: 'Geen winkelwagen beschikbaar',
    modalTitle: 'Toegevoegd aan winkelwagen',
    quantity: 'Aantal',
    continueShopping: 'Verder winkelen',
    proceedToCheckout: 'Naar afrekenen',
  }}
  afterAddToCart={(cart) => saveCart(cart)}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need a custom product card without using this component, here are the data extraction helpers and patterns you need:

### Extracting product data

```ts


// Resolve localised name
function getProductName(product: Product, language: string = 'NL'): string {
  return product.names?.find(n => n.language === language)?.value
    || product.names?.[0]?.value
    || 'Product';
}

// Resolve image URL (first variant of first image)
function getProductImageUrl(product: Product): string {
  return product.media?.images?.items?.[0]?.imageVariants?.[0]?.url || '';
}

// Resolve price: net = incl. VAT, gross = excl. VAT
function getProductPrice(product: Product, includeTax: boolean): string {
  const priceValue = includeTax ? product.price?.net : product.price?.gross;
  return priceValue != null ? `€${Number(priceValue).toFixed(2)}` : '';
}

// Resolve slug for URL
function getProductSlug(product: Product, language: string = 'NL'): string {
  return product.slugs?.find(s => s.language === language)?.value
    || product.slugs?.[0]?.value
    || '';
}

// Build product URL
function getProductUrl(product: Product, language: string = 'NL'): string {
  const slug = getProductSlug(product, language);
  return `/product/${product.productId}/${slug}`;
}
```

### Subscribing to the Price Toggle

To make your custom card react to the global VAT toggle, follow this pattern:

1. On initialization, read `localStorage.getItem('price_include_tax')` to determine the current setting (defaults to `true` if not set).
2. Add a listener for the `priceToggleChanged` custom event on `window`. The event's `detail` property is a boolean indicating whether tax is included.
3. When the event fires, update your displayed price using the new `includeTax` value.
4. Clean up the event listener when the component is destroyed.

### Resolving Attribute Labels

```ts


function getAttributeValue(product: Product, attributeName: string): string {
  const attrs = product.attributes?.items || [];
  const found = attrs.find(
    (a: AttributeResult) => a.attributeDescription?.name === attributeName
  );
  return found?.value?.value || '';
}

// Usage:
const brand = getAttributeValue(product, 'brand');    // "Nike"
const isNew = getAttributeValue(product, 'new');       // "New" or ""
```

Your UI should render:
- A product image (or an SVG placeholder when no image is available) linked to the product URL.
- The product SKU, localised name (as a link), and formatted price.
- Optionally: manufacturer, short description, attribute badges, and a favourite toggle button.
- An AddToCart control in the card footer.

</TabItem>
</Tabs>

---

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Required | Description |
|---|---|---|---|
| `product` | `Product` | Yes | The Propeller product object to display |
| `graphqlClient` | `GraphQLClient` | Yes | Initialised Propeller SDK GraphQL client (forwarded to AddToCart) |
| `user` | `Contact \| Customer \| null` | Yes | Authenticated user (forwarded to AddToCart) |
| `configuration` | `any` | Yes | App configuration object from `@/data/config` — provides `urls.getProductUrl()` for link generation and image filter settings |

### Display Toggles

| Prop | Type | Default | Description |
|---|---|---|---|
| `showName` | `boolean` | `true` | Renders the product name as a clickable link |
| `showImage` | `boolean` | `true` | Renders the product image in an aspect-ratio container |
| `showSku` | `boolean` | `true` | Renders the SKU in monospace style |
| `showShortDescription` | `boolean` | `false` | Renders the first localised short description (2-line clamp) |
| `showManufacturer` | `boolean` | `false` | Renders `product.manufacturer` |
| `showStock` | `boolean` | `false` | Renders the embedded ItemStock availability widget |
| `showAvailability` | `boolean` | `true` | When `showStock` is true, shows the availability indicator text. Only relevant in grid layout |

### Attribute Labels

| Prop | Type | Description |
|---|---|---|
| `imageLabels` | `string[]` | Attribute names whose values render as badge overlays on the product image. Example: `['new', 'sale']` |
| `textLabels` | `string[]` | Attribute names whose values render as extra text rows below the product name. Example: `['brand', 'color']` |

Lookup: each entry is matched against `product.attributes.items[n].attributeDescription.name`. The resolved `value.value` string is rendered. Entries with no match are dropped.

### Pricing and Layout

| Prop | Type | Default | Description |
|---|---|---|---|
| `includeTax` | `boolean` | — | Overrides the price toggle. When `true`, shows tax-inclusive price (`price.net`). When `false`, shows tax-exclusive price (`price.gross`). When omitted, the component follows the global price toggle (see Behavior section) |
| `columns` | `number` | — | When set to `1`, the card renders as a compact horizontal row instead of a vertical card |
| `className` | `string` | — | Extra CSS class applied to the root `<div>` |
| `language` | `string` | `'NL'` | Language code used for resolving localised product names, descriptions, slugs, and forwarded to CartService |

### Favourites

| Prop | Type | Default | Description |
|---|---|---|---|
| `enableAddFavorite` | `boolean` | `false` | Renders a heart-icon toggle button in the top-right corner of the image |
| `onToggleFavorite` | `(product: Product, isFavorite: boolean) => void` | — | Called on every favourite state change. `isFavorite = true` means just added |

### Navigation

| Prop | Type | Description |
|---|---|---|
| `onProductClick` | `(product: Product) => void` | Called when the product name or image is clicked. When provided, the default `<a>` navigation is suppressed so the consumer can use framework routing (e.g. `router.push`) |

### Label Overrides

| Prop | Type | Description |
|---|---|---|
| `labels` | `Record<string, string>` | Override card-level UI strings. Keys: `addToFavorites`, `removeFromFavorites` |
| `stockLabels` | `Record<string, string>` | Override ItemStock UI strings. Keys: `inStock`, `outOfStock`, `lowStock`, `available`, `notAvailable`, `pieces` |

### AddToCart Pass-Through Props

All of these are forwarded to the embedded AddToCart component. See [AddToCart](/reference/storefront-sdk/cart-and-checkout/add-to-cart) for full details.

| Prop | Type | Default | Description |
|---|---|---|---|
| `cartId` | `string` | — | ID of an existing cart |
| `clusterId` | `number` | — | Cluster ID for configurable products |
| `childItems` | `number[]` | — | Product IDs of selected cluster child options |
| `notes` | `string` | — | Free-text notes for the cart item |
| `price` | `number` | — | Custom unit price override |
| `createCart` | `boolean` | `false` | Auto-create a cart when none is available |
| `onCartCreated` | `(cart: Cart) => void` | — | Called after a new cart is created |
| `onAddToCart` | `(product, clusterId?, quantity?, childItems?, notes?, price?, showModal?) => Cart` | — | Custom add-to-cart handler that replaces the internal CartService call |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | — | Called after every successful add |
| `showModal` | `boolean` | `false` | Show a modal after add instead of a toast notification |
| `allowIncrDecr` | `boolean` | `true` | Render increment/decrement buttons around the quantity input |
| `enableStockValidation` | `boolean` | `false` | Block add if quantity exceeds available stock |
| `onProceedToCheckout` | `() => void` | — | Called when the modal's checkout button is clicked |
| `addToCartLabels` | `Record<string, string>` | — | Override AddToCart UI strings (mapped to AddToCart's `labels` prop). Keys: `outOfStock`, `noCartId`, `errorAdding`, `addedToCart`, `modalTitle`, `quantity`, `continueShopping`, `proceedToCheckout`, `add`, `adding` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderProductCard(options: {
  product: Product;
  graphqlClient: GraphQLClient;
  user: Contact | Customer | null;
  language?: string;
  cartId?: string;
  includeTax?: boolean;
}): void
```

Types: `Product`, `GraphQLClient`, `Contact`, `Customer`, `Cart`, `CartMainItem`, `CartChildItemInput`, `AttributeResult` from `propeller-sdk-v2`.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `product` | `Product` | required | `product` prop |
| `graphqlClient` | `GraphQLClient` | required | `graphqlClient` prop |
| `user` | `Contact \| Customer \| null` | required | `user` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `cartId` | `string` | — | `cartId` prop |
| `includeTax` | `boolean` | — | `includeTax` prop |
| `clusterId` | `number` | — | `clusterId` prop |
| `childItems` | `number[]` | — | `childItems` prop |
| `notes` | `string` | — | `notes` prop |
| `price` | `number` | — | `price` prop |

### Cart resolution

The embedded AddToCart uses `graphqlClient` to add items to the cart via CartService. When `cartId` is provided, items are added to that cart. When `createCart` is `true` and no `cartId` exists, a new cart is created first. See [AddToCart](/reference/storefront-sdk/cart-and-checkout/add-to-cart) for the full SDK call sequence.

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onProductClick` | Product name or image is clicked | Navigate to product detail page using your framework's router |
| `onToggleFavorite` | Favourite heart button is toggled | Add/remove product from wishlist |
| `onCartCreated` | A new cart is auto-created | Persist the new cart to your app state |
| `afterAddToCart` | Product successfully added to cart | Update cart state in your app |
| `onAddToCart` | Replaces internal add-to-cart logic | Perform custom add-to-cart using CartService |
| `onProceedToCheckout` | Modal checkout button is clicked | Navigate to checkout page |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showName` — show/hide product name
- `showImage` — show/hide product image
- `showSku` — show/hide SKU
- `showShortDescription` — show/hide short description
- `showManufacturer` — show/hide manufacturer
- `showStock` — show/hide stock widget
- `showAvailability` — show/hide availability text
- `imageLabels` — attribute names for image badges
- `textLabels` — attribute names for text rows
- `columns` — grid vs row layout
- `className` — extra CSS class
- `enableAddFavorite` — show/hide favourite toggle
- `showModal` — modal vs toast after add
- `allowIncrDecr` — show/hide quantity buttons
- `enableStockValidation` — block add when out of stock
- `labels` — card-level UI strings
- `stockLabels` — stock widget UI strings
- `addToCartLabels` — AddToCart UI strings
- `createCart` — auto-create cart flag

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Card labels

| Key | Description |
|---|---|
| `addToFavorites` | Tooltip/aria text for the add favourite button |
| `removeFromFavorites` | Tooltip/aria text for the remove favourite button |

### Stock labels

| Key | Description |
|---|---|
| `inStock` | Text when product is in stock |
| `outOfStock` | Text when product is out of stock |
| `lowStock` | Text when stock is low |
| `available` | Text when product is available |
| `notAvailable` | Text when product is not available |
| `pieces` | Unit label for stock quantity |

### AddToCart labels

| Key | Description |
|---|---|
| `add` | Add button text |
| `adding` | Button text while adding |
| `addedToCart` | Toast/modal message after successful add |
| `outOfStock` | Message when stock is insufficient |
| `errorAdding` | Message on add failure |
| `noCartId` | Message when no cart is available |
| `modalTitle` | Title of the post-add modal |
| `quantity` | Label for the quantity display in modal |
| `continueShopping` | Modal button text to continue shopping |
| `proceedToCheckout` | Modal button text to go to checkout |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  addToFavorites: 'Add to favorites',
  removeFromFavorites: 'Remove from favorites',
};

const defaultStockLabels = {
  inStock: 'In stock',
  outOfStock: 'Out of stock',
  lowStock: 'Low stock',
  available: 'Available',
  notAvailable: 'Not available',
  pieces: 'pieces',
};

const defaultAddToCartLabels = {
  add: 'Add',
  adding: 'Adding...',
  addedToCart: 'added to cart',
  outOfStock: 'Out of stock',
  errorAdding: 'Error adding to cart',
  noCartId: 'No cart available',
  modalTitle: 'Added to cart',
  quantity: 'Quantity',
  continueShopping: 'Continue shopping',
  proceedToCheckout: 'Proceed to checkout',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Price Toggle (VAT Switch)

The component participates in the global price toggle system:

- On mount, it reads `localStorage.getItem('price_include_tax')` to determine whether to show tax-inclusive or tax-exclusive prices.
- It listens for the `priceToggleChanged` custom event, dispatched by the PriceToggle component, and updates the displayed price in real time.
- The `includeTax` prop overrides this automatic behavior when explicitly passed.
- **Price field mapping**: `product.price.net` is the tax-inclusive price; `product.price.gross` is the tax-exclusive price. Prices are formatted as `€X.XX`.

### Image Handling

- The first image variant is used: `product.media.images.items[0].imageVariants[0].url`.
- When no image is available, a grey SVG placeholder icon is rendered in its place.
- Images scale up slightly on hover (`group-hover:scale-105`).

### Product URL Generation

Product links are generated via `configuration.urls.getProductUrl(product, language)`, which uses the configured URL pattern (default: `/product/{id}/{slug}`) with optional language prefixes.

### Favourite Toggle

The component keeps an internal `isFavorite` boolean (starts as `false`). Clicking the heart button flips it and fires `onToggleFavorite(product, newState)`. There is no initial-state prop -- if you need to pre-seed the favourite state, manage the UI externally.

### Navigation

The product name and image both render as `<a>` links. If `onProductClick` is provided, `e.preventDefault()` is called and the callback handles routing instead, enabling SPA navigation without a full page reload.

### Row vs Grid Layout

When `columns` is `1`, the card renders as a compact horizontal row:
- Image is a small 80x80px thumbnail on the left
- Name and details are inline in the middle
- Price and AddToCart appear on the right
- On mobile, the bottom section wraps below with a border separator

When `columns` is any other value (or omitted), the standard vertical card layout is used.

### Embedded AddToCart

The AddToCart component is mounted in the card footer. The card's `addToCartLabels` prop is mapped to AddToCart's `labels` prop to avoid collision with the card-level `labels` prop (which controls the favourite button strings).

---

## SDK Services and Types

### Types Used

| Import | Package | Purpose |
|---|---|---|
| `Product` | `propeller-sdk-v2` | The main product data object |
| `GraphQLClient` | `propeller-sdk-v2` | SDK client instance for API calls |
| `Contact` | `propeller-sdk-v2` | B2B user type |
| `Customer` | `propeller-sdk-v2` | B2C user type |
| `Cart` | `propeller-sdk-v2` | Cart object returned after add-to-cart |
| `CartMainItem` | `propeller-sdk-v2` | Individual cart line item |
| `CartChildItemInput` | `propeller-sdk-v2` | Input type for cluster child items |
| `AttributeResult` | `propeller-sdk-v2` | Product attribute with description and value |

### Product Fields Accessed

| Data | Field Path on `Product` |
|---|---|
| Name | `names[].value` (filtered by `language`) |
| SKU | `sku` |
| Image URL | `media.images.items[0].imageVariants[0].url` |
| Price (incl. VAT) | `price.net` |
| Price (excl. VAT) | `price.gross` |
| Short description | `shortDescriptions[].value` (filtered by `language`) |
| Manufacturer | `manufacturer` |
| Slugs | `slugs[].value` (filtered by `language`) |
| Stock | `inventory` (forwarded to ItemStock) |
| Attributes | `attributes.items[].attributeDescription.name` and `attributes.items[].value.value` |

---

## GraphQL Query Examples

### Fetching Products for ProductCard

The `Product` object passed to ProductCard should include at minimum these fields:

```graphql
query Products($categoryId: Int!, $language: String) {
  products(categoryId: $categoryId, language: $language) {
    items {
      productId
      sku
      manufacturer
      names {
        value
        language
      }
      slugs {
        value
        language
      }
      shortDescriptions {
        value
        language
      }
      price {
        net
        gross
      }
      media {
        images(searchFilters: { transformations: ["fill"] }) {
          items {
            imageVariants(
              filters: {
                width: 400
                height: 400
                transformations: ["fill"]
              }
            ) {
              url
            }
          }
        }
      }
      inventory {
        totalQuantity
        supplierQuantity
      }
      attributes {
        items {
          attributeDescription {
            name
            code
          }
          value {
            value
          }
        }
      }
    }
  }
}
```

### Fetching a Single Product

```graphql
query Product($productId: Int!, $language: String) {
  product(productId: $productId, language: $language) {
    productId
    sku
    manufacturer
    names { value language }
    slugs { value language }
    shortDescriptions { value language }
    price { net gross }
    media {
      images {
        items {
          imageVariants(filters: { width: 400, height: 400 }) {
            url
          }
        }
      }
    }
    inventory { totalQuantity supplierQuantity }
    attributes {
      items {
        attributeDescription { name code }
        value { value }
      }
    }
  }
}
```

---

## ProductDescription

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-description

# ProductDescription

Renders a product's HTML description with optional truncation and expand/collapse functionality. Resolves the correct localized description from the product's `descriptions` array and renders it as raw HTML using `dangerouslySetInnerHTML`.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage

```tsx


<ProductDescription product={product} />
```

### With a specific language

```tsx
<ProductDescription
  product={product}
  language="EN"
/>
```

### Collapsed with truncation

Show the first 300 characters with a "Read more" toggle to expand.

```tsx
<ProductDescription
  product={product}
  language="NL"
  collapsed={true}
  maxLength={300}
/>
```

### Collapsed with a short preview

```tsx
<ProductDescription
  product={product}
  collapsed={true}
  maxLength={150}
  className="my-8"
/>
```

### Cluster product

The component accepts both `Product` and `Cluster` objects. Both share the same `descriptions` field structure.

```tsx
<ProductDescription
  product={cluster}
  language="EN"
  collapsed={true}
  maxLength={500}
/>
```

### Custom styling

```tsx
<ProductDescription
  product={product}
  className="border-t pt-6 mt-6"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need custom rendering logic (e.g., sanitizing the HTML, rendering Markdown instead, or integrating a "show more" animation), you can extract the description from the product object directly:

### Basic usage

```ts


function getProductDescription(
  product: Product,
  language: string = 'NL'
): string {
  if (!product?.descriptions?.length) return '';

  const match = product.descriptions.find(
    (d: LocalizedString) => d.language === language
  );

  return match?.value || product.descriptions[0]?.value || '';
}

// pseudo-code
const html = getProductDescription(product, 'EN');
```

### With a specific language

```ts
const html = getProductDescription(product, 'EN');
// Render `html` as raw HTML in your template
```

### With HTML sanitization

You can sanitize the HTML before rendering using a library like DOMPurify:

```ts


const raw = getProductDescription(product, 'NL');
const clean = DOMPurify.sanitize(raw);
// Render `clean` as raw HTML in your template
```

### With truncation and expand/collapse

For truncation with expand/collapse, use a helper function and a boolean toggle:

```ts
// pseudo-code

function truncateHtml(html: string, maxChars: number): string {
  const plain = html.replace(/<[^>]*>/g, '');
  if (plain.length <= maxChars) return html;

  const cut = plain.substring(0, maxChars);
  const lastSpace = cut.lastIndexOf(' ');
  return (lastSpace > 0 ? cut.substring(0, lastSpace) : cut) + '\u2026';
}

const html = getProductDescription(product);
const plain = html.replace(/<[^>]*>/g, '');
const needsTruncation = plain.length > maxLength;

// Track an `expanded` boolean in your framework's state mechanism.
// When collapsed and truncation is needed, render `truncateHtml(html, maxLength)` as plain text.
// When expanded or no truncation is needed, render the full `html` as raw HTML.
// Show a "Read more" / "Read less" toggle button when `needsTruncation` is true.
```

### Cluster product

The same `getProductDescription` function works for both `Product` and `Cluster` objects, as both share the same `descriptions` field structure.

```ts
const clusterHtml = getProductDescription(cluster, 'EN');
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `product` | `Product \| Cluster` | Product or Cluster object. The component reads the `descriptions` array to find the matching localized entry |

### Localization

| Prop | Type | Default | Description |
|---|---|---|---|
| `language` | `string` | `'NL'` | Language code used to resolve the correct entry from `product.descriptions`. Falls back to the first available description if no match is found |

### Truncation

| Prop | Type | Default | Description |
|---|---|---|---|
| `collapsed` | `boolean` | `false` | When `true`, the description is initially collapsed to `maxLength` characters with a "Read more" toggle |
| `maxLength` | `number` | `0` | Maximum number of plain-text characters shown when collapsed. `0` disables truncation entirely, even when `collapsed` is `true` |

### Appearance

| Prop | Type | Default | Description |
|---|---|---|---|
| `className` | `string` | -- | Extra CSS class applied to the root `<div>` element |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function getProductDescription(
  product: Product,
  language?: string   // default: 'NL'
): string
```

Returns the resolved HTML description string from the product's `descriptions` array.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `product` | `Product \| Cluster` | *(required)* | `product` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `maxLength` | `number` | `0` | `maxLength` prop — used for truncation logic |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `className` — extra CSS class on the root element
- `collapsed` — controls whether the description starts in truncated state

</TabItem>
</Tabs>

---

## Behavior

### HTML rendering

The description value is rendered as raw HTML via `dangerouslySetInnerHTML`. The rendered content is wrapped in a `div` with Tailwind typography classes (`prose prose-slate max-w-none text-muted-foreground`), so standard HTML elements like headings, paragraphs, lists, and links are styled automatically.

### Truncation

Truncation only activates when **all three** conditions are met:

1. `collapsed` is `true`
2. `maxLength` is greater than `0`
3. The plain-text length of the description exceeds `maxLength`

When truncating, the component:

- Strips all HTML tags to produce a plain-text version.
- Cuts the text at `maxLength` characters.
- Snaps backward to the last word boundary to avoid cutting mid-word.
- Appends an ellipsis character.

The truncated version is rendered as plain text (not HTML), so any formatting, links, or images from the original description are removed in the collapsed state.

### Expand / Collapse

When truncation is active, a toggle button appears below the description text:

- **"Read more"** -- Expands the description to show the full HTML content.
- **"Read less"** -- Collapses back to the truncated plain-text preview.

The toggle button is styled as a text link (`text-primary hover:underline`).

### Empty state

If the product has no `descriptions` array, or if no matching language entry is found and there is no fallback entry, the component renders nothing (the entire root element is hidden).

### Reactivity

The component re-evaluates the description whenever the `product` or `language` prop changes. Switching products or languages resets the resolved HTML and re-applies truncation rules.

---

## GraphQL Query

When fetching a product, include the `descriptions` field to supply this component with data:

```graphql
query Product(
  $productId: Int!
  $language: String
) {
  product(id: $productId) {
    productId
    sku
    names(language: $language) { value language }
    descriptions(language: $language) { value language }
  }
}
```

Variables:

```json
{
  "productId": 42,
  "language": "NL"
}
```

For a cluster:

```graphql
query Cluster(
  $clusterId: Int!
  $language: String
) {
  cluster(id: $clusterId) {
    clusterId
    names(language: $language) { value language }
    descriptions(language: $language) { value language }
  }
}
```

Note: Even when requesting a specific `language` in the query, the API may return multiple localized entries. The component performs its own language matching on the returned array.

---

## SDK Services

This component does not call any SDK services directly. It reads data from a `Product` or `Cluster` object that has already been fetched.

### Product fields used

| Field | Type | Purpose |
|---|---|---|
| `product.descriptions` | `LocalizedString[]` | Array of localized description entries. Each entry has `language` (string) and `value` (string, may contain HTML) |

The component resolves the description in this order:

1. Finds the first entry in `descriptions` where `language` matches the `language` prop.
2. If no match, falls back to `descriptions[0].value`.
3. If `descriptions` is empty or missing, renders nothing.

---

## ProductDownloads

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-downloads

# ProductDownloads

Renders a list of downloadable documents associated with a product. Each item is displayed as a styled link that opens in a new tab with a native download prompt. When no documents are available, an empty-state message is shown instead.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage on a product detail page

```tsx


<ProductDownloads
  downloads={product.media.documents}
  language="EN"
/>
```

### With custom labels

```tsx
<ProductDownloads
  downloads={product.media.documents}
  language="NL"
  labels={{
    title: 'Bestanden',
    empty: 'Geen bestanden beschikbaar',
  }}
/>
```

### With a custom CSS class

```tsx
<ProductDownloads
  downloads={product.media.documents}
  language="EN"
  className="mt-6 border-t pt-4"
/>
```

### Conditionally rendering only when documents exist

```tsx
{product.media?.documents?.items?.length > 0 && (
  <ProductDownloads
    downloads={product.media.documents}
    language="EN"
    labels={{ title: 'Product Documents' }}
  />
)}
```

### Inside a tabbed product detail layout

```tsx
<Tabs>
  <Tab label="Description">
    <ProductDescription product={product} />
  </Tab>
  <Tab label="Downloads">
    <ProductDownloads
      downloads={product.media.documents}
      language={currentLanguage}
      labels={{ title: 'Technical Documents', empty: 'No documents for this product.' }}
      className="p-4"
    />
  </Tab>
</Tabs>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need a custom downloads component, here is what to keep in mind:

1. **Accept `PaginatedMediaDocumentResponse` as input.** This is the shape returned by the Propeller API for `product.media.documents`. Working with this type directly avoids unnecessary data transformation.

2. **Resolve localized fields by language.** Both the document URL (`LocalizedDocument.originalUrl`) and the display name (`LocalizedString.value`) are arrays keyed by language. Search for a match on the provided language code first, then fall back to the first array entry.

3. **Skip items without a URL.** Some `MediaDocument` entries may have metadata but no downloadable file. Filter these out or hide them to avoid broken links.

4. **Use `target="_blank"` and the `download` attribute.** Opening in a new tab prevents navigation away from the product page. The `download` attribute signals the browser to download instead of displaying the file inline.

5. **Handle the empty state.** When `downloads.items` is empty or undefined, show a meaningful message rather than rendering an empty container.

6. **MIME type is available if needed.** Each `LocalizedDocument` includes a `mimeType` field (e.g. `"application/pdf"`). You can use this to display file type icons or badges. The default component resolves it but does not render it.

### Resolving localized document fields

```ts

  PaginatedMediaDocumentResponse,
  MediaDocument,
  LocalizedDocument,
  LocalizedString,
} from 'propeller-sdk-v2';

function resolveDocumentUrl(doc: MediaDocument, language: string): string {
  const match = doc.documents?.find(
    (d: LocalizedDocument) => d.language === language
  );
  return match?.originalUrl || doc.documents?.[0]?.originalUrl || '';
}

function resolveDocumentName(doc: MediaDocument, language: string): string {
  const match = doc.alt?.find(
    (a: LocalizedString) => a.language === language
  );
  return match?.value || doc.alt?.[0]?.value || 'Download';
}

// Iterate over items
const items = downloads?.items || [];
for (const doc of items) {
  const url = resolveDocumentUrl(doc, 'EN');
  const name = resolveDocumentName(doc, 'EN');
  if (!url) continue; // skip items without a URL
  // Render a link: <a href={url} target="_blank" download>{name}</a>
}
```

### Conditional rendering

```ts
const hasDocuments = (downloads?.items?.length ?? 0) > 0;
// Only render the downloads section when hasDocuments is true
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `downloads` | `PaginatedMediaDocumentResponse` | Yes | The media documents object from the product. Pass `product.media.documents` directly. |
| `language` | `string` | Yes | Two-letter language code (e.g. `"EN"`, `"NL"`) used to resolve the correct localized document URL and display name. |

### Customization

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `labels` | `Record<string, string>` | No | See below | Override any UI string. Available keys: `title`, `empty`. |
| `className` | `string` | No | `""` | Extra CSS class applied to the root `<div>` element. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderProductDownloads(
  downloads: PaginatedMediaDocumentResponse,
  language: string
): void
```

All types are imported from `propeller-sdk-v2`.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `downloads` | `PaginatedMediaDocumentResponse` | *(required)* | `downloads` prop |
| `language` | `string` | *(required)* | `language` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `labels` — override UI strings (`title`, `empty`)
- `className` — extra CSS class on the root element

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default |
|-----|---------|
| `title` | `"Downloads"` |
| `empty` | `"No downloads"` |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  title: 'Downloads',
  empty: 'No downloads',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

- **Language matching**: The component matches the `language` prop against `LocalizedDocument.language` and `LocalizedString.language`. If no match is found, the first entry in each array is used as a fallback. If the array is empty, safe defaults are applied (empty string for URL, `"Download"` for name).

- **Empty state**: When `downloads.items` is empty, undefined, or has zero length, the title heading is hidden and the empty-state message is displayed.

- **Hidden links**: Individual list items where the resolved URL is an empty string are not rendered. This prevents broken download links from appearing.

- **Styling**: The component uses Tailwind CSS utility classes. Each download link is rendered as a bordered row with a file icon on the left, a truncated document name in the middle, and a download arrow icon on the right. Hover states change the border and icon colors.

- **No pagination**: The component renders all items present in `downloads.items` at once. If you need pagination, handle it at the query level by adjusting the `page` and `offset` arguments on the `documents` field in your GraphQL query.

---

## GraphQL Query Example

To fetch the data this component needs, include `media.documents` in your product query:

```graphql
query ProductWithDownloads($productId: Int!, $language: String) {
  product(id: $productId, language: $language) {
    productId
    name {
      value
      language
    }
    media {
      documents(page: 1, offset: 100) {
        items {
          alt {
            language
            value
          }
          documents {
            language
            originalUrl
            mimeType
          }
        }
        itemsFound
        page
        pages
        offset
      }
    }
  }
}
```

Pass the result as:

```tsx
<ProductDownloads
  downloads={product.media.documents}
  language="EN"
/>
```

---

## SDK Services

This component does not call any SDK service directly. It is a pure presentational component that receives pre-fetched data via the `downloads` prop.

### Required product fields

The component reads from the `product.media.documents` portion of a product query response. The relevant SDK types are:

| Type | Fields used |
|------|-------------|
| `PaginatedMediaDocumentResponse` | `items` (array of `MediaDocument`) |
| `MediaDocument` | `documents` (array of `LocalizedDocument`), `alt` (array of `LocalizedString`) |
| `LocalizedDocument` | `language`, `originalUrl`, `mimeType` |
| `LocalizedString` | `language`, `value` |

All four types are imported from `propeller-sdk-v2`.

### Field resolution logic

- **Document URL**: Finds the first entry in `doc.documents` matching the provided `language`. Falls back to the first entry in the array. Returns an empty string if nothing is available (the link is hidden in that case).
- **Document name**: Finds the first entry in `doc.alt` matching the provided `language`. Falls back to the first entry, then to the string `"Download"`.
- **MIME type**: Resolved the same way as the URL (language match, then first entry). Currently resolved internally but not displayed in the UI.

---

## ProductGallery

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-gallery

# ProductGallery

Image gallery for product detail pages with thumbnail navigation, hover zoom, and fullscreen lightbox.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage

```tsx
<ProductGallery
  images={[
    'https://cdn.example.com/products/shoe-front.jpg',
    'https://cdn.example.com/products/shoe-side.jpg',
    'https://cdn.example.com/products/shoe-back.jpg',
  ]}
/>
```

### With product data from the SDK

```tsx
const images = product.media?.images?.items?.flatMap(
  (item) => item.imageVariants?.map((v) => v.url) ?? []
) ?? [];

<ProductGallery images={images} />
```

### Thumbnails disabled (single hero image)

```tsx
<ProductGallery images={images} showThumbnails={false} />
```

### Zoom and lightbox disabled (static display)

```tsx
<ProductGallery
  images={images}
  enableZoom={false}
  enableLightbox={false}
/>
```

### Custom styling

```tsx
<ProductGallery images={images} className="max-w-lg mx-auto" />
```

### Loading / skeleton state

Pass an empty array while data is loading. The component renders an SVG placeholder automatically.

```tsx
const [images, setImages] = useState<string[]>([]);

<ProductGallery images={images} />
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To replace or extend this component, implement the following:

1. **Accept a `string[]` of image URLs.** Keep the component decoupled from the SDK -- let the parent extract URLs from the product object.

2. **Track `selectedIndex` state** to control which image is displayed as the main image.

3. **Thumbnail strip.** Render a scrollable row of clickable thumbnails. Highlight the active one. Hide the strip when there is only one image.

4. **Lightbox overlay.** Use a fixed-position overlay (`z-50`) with backdrop click to close. Add prev/next buttons that wrap around the image array. Always call `stopPropagation` on interactive elements inside the overlay.

5. **Zoom behavior.** CSS `hover:scale-*` on the main image is the simplest approach. For a magnifier loupe, track mouse position and render a clipped, enlarged copy of the image.

6. **Empty state.** Render a placeholder (SVG icon, skeleton box, or spinner) when the images array is empty so the layout does not collapse.

7. **Accessibility.** Add `aria-label` attributes to navigation buttons. Consider keyboard navigation (arrow keys in lightbox, Escape to close).

### Extracting images from product data

```ts
// All variants of the first image
const firstImageVariants =
  product.media?.images?.items?.[0]?.imageVariants?.map((v) => v.url) ?? [];

// One variant per image (e.g. the first/largest variant of each)
const onePerImage =
  product.media?.images?.items?.map(
    (item) => item.imageVariants?.[0]?.url ?? ''
  ).filter(Boolean) ?? [];
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Image Data

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `images` | `string[]` | *(required)* | Array of image URLs to display. An empty array triggers the skeleton/placeholder state. |

### Display Options

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showThumbnails` | `boolean` | `true` | Show the horizontal thumbnail strip below the main image. Hidden automatically when only one image is provided. |
| `enableZoom` | `boolean` | `true` | Show a zoom-in cursor on hover and apply a subtle scale-up effect on the main image. |
| `enableLightbox` | `boolean` | `true` | Allow clicking the main image to open a fullscreen overlay. |

### Layout

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `className` | `string` | `undefined` | Additional CSS class(es) applied to the root `<div>`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderProductGallery(
  images: string[]
): void
```

The component is data-agnostic: it accepts plain `string[]` URLs. The URLs typically come from the Propeller product media structure (`product.media.images.items[].imageVariants[].url`).

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `images` | `string[]` | *(required)* | `images` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `showThumbnails` — toggle thumbnail strip visibility
- `enableZoom` — toggle hover zoom effect
- `enableLightbox` — toggle fullscreen lightbox on click
- `className` — extra CSS class on the root element

</TabItem>
</Tabs>

---

## Behavior

### Thumbnail Navigation

- Thumbnails appear in a horizontal strip below the main image when `showThumbnails` is `true` (default) and more than one image is provided.
- Clicking a thumbnail immediately switches the main image.
- The active thumbnail is highlighted with a primary-color border and ring.
- The strip scrolls horizontally (`overflow-x-auto`) when thumbnails exceed the container width.

### Zoom

- When `enableZoom` is `true`, hovering the main image shows a `cursor-zoom-in` pointer and scales the image up slightly (`hover:scale-105`).
- This is a CSS-only effect; no magnifier loupe is rendered.

### Fullscreen Lightbox

- Clicking the main image (when `enableLightbox` is `true`) opens a fixed overlay covering the viewport with a semi-transparent black backdrop.
- The lightbox displays the current image at maximum size while preserving aspect ratio.
- Navigation arrows (previous / next) appear on the left and right edges when multiple images exist. Clicking wraps around (last image -> first, and vice versa).
- A close button sits in the top-right corner.
- Clicking the backdrop (outside the image) also closes the lightbox.
- Click events on the image and controls call `stopPropagation` so they do not accidentally close the overlay.

### Responsive

- The main image area uses `aspect-square` to maintain a 1:1 ratio at any width.
- Images use `object-contain` with padding (`p-8`) so they are never cropped.
- Thumbnails are fixed at 80x80px (`w-20 h-20`) with `flex-shrink-0`, scrolling horizontally on smaller screens.
- The lightbox is fully responsive: `max-h-full max-w-full` ensures the image fits any viewport.

### Empty / Loading State

- When `images` is an empty array the component renders a light gray placeholder with an SVG image icon, serving as a skeleton state while data loads.

---

## GraphQL Query Example

Request product images with specific transformations using `imageVariantFilters`:

```graphql
query ProductWithImages($productId: Int!) {
  product(id: $productId) {
    productId
    name {
      value
    }
    media {
      images {
        items {
          imageVariants(input: {
            transformations: [
              { name: "fill", width: 800, height: 800 }
            ]
          }) {
            url
          }
        }
      }
    }
  }
}
```

> **Note:** The `transformations` array must not be empty. The Propeller API rejects an empty `{}` for `imageVariantFilters`.

---

## SDK Services -- Product Media Fields

The component itself is data-agnostic: it accepts plain `string[]` URLs. The URLs typically come from the Propeller product media structure.

### Fields read from a `Product` object

```
product
  └─ media
       └─ images
            └─ items[]
                 └─ imageVariants[]
                      └─ url        <-- the URL string you pass to `images`
```

Each `items` entry represents one product image. Each image can have multiple `imageVariants` (different sizes/transforms). Pick the variant that suits your display size.

### Extracting images

```ts
// All variants of the first image
const firstImageVariants =
  product.media?.images?.items?.[0]?.imageVariants?.map((v) => v.url) ?? [];

// One variant per image (e.g. the first/largest variant of each)
const onePerImage =
  product.media?.images?.items?.map(
    (item) => item.imageVariants?.[0]?.url ?? ''
  ).filter(Boolean) ?? [];
```

---

## ProductGrid

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-grid

# ProductGrid

A self-contained product listing component that handles data fetching, pagination, sorting, filtering, and cart integration. It can operate in two modes: **self-fetching** (provide a `graphqlClient` and let it query the API internally) or **controlled** (pass pre-fetched `products` directly).

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Category page

Display products from a specific category with full cart integration:

```tsx


<ProductGrid
  graphqlClient={graphqlClient}
  categoryId={42}
  language="NL"
  columns={3}
  cartId={cart?.cartId}
  createCart={true}
  user={authState.user}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  configuration={config}
/>
```

### Search results

Pass a `term` prop to search across the entire catalog. The grid automatically uses `baseCategoryId` from the configuration and sets sort to `RELEVANCE`:

```tsx
<ProductGrid
  graphqlClient={graphqlClient}
  term={searchQuery}
  language="NL"
  columns={3}
  cartId={cart?.cartId}
  createCart={true}
  user={authState.user}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  onItemsFoundChange={(count) => setResultCount(count)}
  configuration={config}
/>
```

### With filters sidebar

Wire up a `GridFilters` sidebar by connecting the grid's filter callbacks to external state:

```tsx
const [filters, setFilters] = useState<AttributeFilter[]>([]);
const [textFilters, setTextFilters] = useState<ProductTextFilterInput[]>([]);
const [priceMin, setPriceMin] = useState<number | undefined>();
const [priceMax, setPriceMax] = useState<number | undefined>();
const [priceBounds, setPriceBounds] = useState({ min: 0, max: 0 });

<GridFilters
  filters={filters}
  onFilterChange={(updated) => setTextFilters(updated)}
  onPriceChange={(min, max) => { setPriceMin(min); setPriceMax(max); }}
  priceBoundsMin={priceBounds.min}
  priceBoundsMax={priceBounds.max}
/>

<ProductGrid
  graphqlClient={graphqlClient}
  categoryId={42}
  textFilters={textFilters}
  priceFilterMin={priceMin}
  priceFilterMax={priceMax}
  onFiltersChange={(f) => setFilters(f)}
  onPriceBoundsChange={(min, max) => setPriceBounds({ min, max })}
  configuration={config}
/>
```

### With external pagination and toolbar

Connect to `GridPagination` and `GridToolbar` via callbacks:

```tsx
const [page, setPage] = useState(1);
const [productsResponse, setProductsResponse] = useState<ProductsResponse | null>(null);
const [category, setCategory] = useState<Category | null>(null);

<GridToolbar
  sortField={sortField}
  sortOrder={sortOrder}
  onSortChange={(field, order) => { setSortField(field); setSortOrder(order); }}
/>

<ProductGrid
  graphqlClient={graphqlClient}
  categoryId={42}
  page={page}
  pageSize={12}
  sortField={sortField}
  sortOrder={sortOrder}
  onProductsResponse={setProductsResponse}
  onCategoryChange={setCategory}
  onPageChange={setPage}
  configuration={config}
/>

<GridPagination
  products={productsResponse}
  onPageChange={setPage}
/>
```

### With cart integration (full pattern)

The grid manages add-to-cart through embedded `ProductCard` and `AddToCart` components. To keep the app's `CartContext` in sync:

```tsx
const { cart, saveCart } = useCart();
const { state: authState } = useAuth();

<ProductGrid
  graphqlClient={graphqlClient}
  categoryId={42}
  cartId={cart?.cartId}
  createCart={true}
  user={authState.user}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  showModal={false}
  allowIncrDecr={true}
  stockValidation={true}
  showStock={true}
  configuration={config}
/>
```

### Pre-fetched products (controlled mode)

When the parent manages data fetching, pass products directly. The grid skips all internal API calls:

```tsx
<ProductGrid
  products={myProducts}
  isLoading={isFetching}
  columns={4}
  configuration={config}
/>
```

### Catalog-only mode (no add-to-cart)

For a read-only catalog view, use `portalMode="semi-closed"` or `allowAddToCart={false}`:

```tsx
<ProductGrid
  graphqlClient={graphqlClient}
  categoryId={42}
  portalMode="semi-closed"
  configuration={config}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom product grid that replaces or extends this component:

### Category page — data fetching

```ts



const service = new CategoryService(graphqlClient);

const variables: CategoryQueryVariables = {
  categoryId: 42,
  language: 'NL',
  categoryProductSearchInput: {
    language: 'NL',
    page: 1,
    offset: 12,
    hidden: false,
    statuses: ['A', 'P', 'T', 'S'],
    sortInputs: [{ field: 'NAME', order: 'ASC' }],
  },
  priceCalculateProductInput: {
    taxZone: 'NL',
  },
  // imageSearchFilters and imageVariantFilters from configuration
};

const result = await service.getCategory(variables);
const products = result?.products?.items || [];
const filters = result?.products?.filters || [];
const minPrice = result?.products?.minPrice;
const maxPrice = result?.products?.maxPrice;
const itemsFound = result?.products?.itemsFound;
```

### Search results

```ts
const searchVariables: CategoryQueryVariables = {
  categoryId: config.baseCategoryId, // e.g. 17
  language: 'NL',
  categoryProductSearchInput: {
    language: 'NL',
    page: 1,
    offset: 12,
    hidden: false,
    statuses: ['A', 'P', 'T', 'S'],
    term: 'laptop',
    searchFields: [
      {
        fieldNames: ['NAME', 'KEYWORDS', 'SKU', 'CUSTOM_KEYWORDS'],
        boost: 5,
      },
      {
        fieldNames: ['DESCRIPTION', 'MANUFACTURER', 'MANUFACTURER_CODE', 'EAN_CODE', 'BAR_CODE', 'CLUSTER_ID', 'CUSTOM_KEYWORDS', 'PRODUCT_ID', 'SHORT_DESCRIPTION', 'SUPPLIER', 'SUPPLIER_CODE'],
        boost: 1,
      },
    ],
    sortInputs: [{ field: 'RELEVANCE', order: 'ASC' }],
  },
};

const result = await service.getCategory(searchVariables);
```

### With text filters and price range

```ts
const filteredVariables: CategoryQueryVariables = {
  categoryId: 42,
  language: 'NL',
  categoryProductSearchInput: {
    language: 'NL',
    page: 1,
    offset: 12,
    hidden: false,
    statuses: ['A', 'P', 'T', 'S'],
    textFilters: [
      { searchId: 'color', values: ['red', 'blue'] },
    ],
    price: { from: 50, to: 200 },
    sortInputs: [{ field: 'NAME', order: 'ASC' }],
  },
};

const result = await service.getCategory(filteredVariables);
// result.products.filters -> pass to filter sidebar
// result.products.minPrice / maxPrice -> pass to price range slider
```

### Product type detection

```ts
// The API returns a mixed array of Product and Cluster items.
// Distinguish them by checking for `clusterId`:
for (const item of products) {
  if ('clusterId' in item) {
    // This is a Cluster
  } else {
    // This is a Product
  }
}
```

### Language filtering (client-side)

```ts
// Filter items to include only those with a translation for the active language
const filtered = products.filter((item) =>
  item.names?.some((n) => n.language === language)
);
const adjustedItemsFound = (itemsFound ?? 0) - (products.length - filtered.length);
```

### Cart integration

```ts


const cartService = new CartService(graphqlClient);

// Create a new cart when none exists
// Not documented in source — implement based on your setup

// Add product to cart
// Pass cartId and graphqlClient to your add-to-cart controls.
// Handle the onCartCreated flow when no cart exists yet:
// CartService will create one, and you must persist the new cart ID.
```

### Stale response handling

```ts
// When filter/sort/page changes trigger rapid re-fetches, use an
// incrementing fetchId counter to discard responses from superseded requests.
let fetchId = 0;

async function fetchProducts(variables: CategoryQueryVariables) {
  const currentFetchId = ++fetchId;
  const result = await service.getCategory(variables);
  if (currentFetchId !== fetchId) return; // discard stale response
  // Apply result
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data Source

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | -- | Initialized SDK GraphQL client. Required when `products` is not provided. |
| `products` | `(Product \| Cluster)[]` | -- | Pre-fetched items. When provided, the grid skips internal fetching entirely. Pass `[]` for empty state. |

### Query Mode

These props only apply when `graphqlClient` is provided and `products` is not.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `categoryId` | `number` | `config.baseCategoryId` | Category to list products from. |
| `term` | `string` | -- | Search term. Searches the full catalog using `baseCategoryId`. Auto-sets sort to `RELEVANCE` when no sort is explicitly set. |
| `brand` | `string` | -- | Manufacturer/brand name filter. Uses `baseCategoryId` for a catalog-wide search. |

### Locale and Pricing

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `language` | `string` | `'NL'` | Language code for product data and name filtering. |
| `taxZone` | `string` | `'NL'` | Tax zone for price calculation. |
| `includeTax` | `boolean` | `false` | When true, shows tax-inclusive prices as the leading price. |

### Layout

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `columns` | `number` | `3` | Number of grid columns. Accepts 1, 2, 3, or 4. `1` = single-column flex layout; `2` = 2-column grid; `3` (default) = 2-col on mobile, 3 on `lg`; `4` = 2-col on mobile, 4 on `lg`. |
| `className` | `string` | -- | Extra CSS class on the root element. |
| `isLoading` | `boolean` | `false` | Force skeleton loader display. Useful in controlled mode. |

### Pagination and Sorting

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `page` | `number` | internal | Externally controlled page number. Overrides internal page counter when provided. |
| `pageSize` | `number` | `12` | Items per page. Triggers re-fetch and resets to page 1 when changed. |
| `sortField` | `string` | -- | Sort field (e.g. `'NAME'`, `'PRICE'`, `'RELEVANCE'`). Overrides internal sort state. |
| `sortOrder` | `string` | `'ASC'` | Sort direction: `'ASC'` or `'DESC'`. |

### Filtering

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `textFilters` | `ProductTextFilterInput[]` | -- | Active attribute filters. Triggers re-fetch and resets to page 1 when changed. |
| `priceFilterMin` | `number` | -- | Minimum price filter bound. |
| `priceFilterMax` | `number` | -- | Maximum price filter bound. |

### Cart Integration

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `cartId` | `string` | -- | Existing cart ID to add items into. |
| `createCart` | `boolean` | -- | Auto-create a cart when none exists. Pair with `onCartCreated`. |
| `onCartCreated` | `(cart: Cart) => void` | -- | Called after a new cart is created internally. Persist the cart to your context here. |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | -- | Called after every successful add-to-cart. Update your cart context here. |
| `showModal` | `boolean` | `false` | Show a success modal instead of a toast after adding to cart. |
| `allowIncrDecr` | `boolean` | `true` | Show quantity stepper buttons in AddToCart. |
| `onProceedToCheckout` | `() => void` | -- | Called when "Proceed to checkout" is clicked in the AddToCart modal. |
| `addToCartLabels` | `Record<string, string>` | -- | Label overrides for AddToCart. Keys: `add`, `adding`, `addedToCart`, `outOfStock`, `noCartId`, `errorAdding`, `modalTitle`, `quantity`, `continueShopping`, `proceedToCheckout`. |

### Visibility and Access Control

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `user` | `Contact \| Customer \| null` | -- | Authenticated user. Passed to ProductCard/AddToCart for price calculation and permissions. |
| `portalMode` | `string` | `'open'` | `'open'` shows AddToCart on cards. `'semi-closed'` hides it (catalog-only). |
| `allowAddToCart` | `boolean` | `true` | When false, hides AddToCart on product cards. ClusterCards always show their navigation button. |

### Stock Display

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showStock` | `boolean` | `false` | Show stock/availability widget on each product card. |
| `showAvailability` | `boolean` | `true` | Show only the availability indicator inside the stock widget. |
| `stockValidation` | `boolean` | `false` | Block add-to-cart when quantity exceeds available stock. |
| `stockLabels` | `Record<string, string>` | -- | Label overrides for ItemStock. Keys: `inStock`, `outOfStock`, `lowStock`, `available`, `notAvailable`, `pieces`. |

### Favorites

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `enableAddFavorite` | `boolean` | -- | Show a heart-icon favorite toggle on each card. |
| `onToggleFavorite` | `(item: Product \| Cluster, isFavorite: boolean) => void` | -- | Called when a favorite is toggled. |

### Card Interaction

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `onProductClick` | `(product: Product) => void` | -- | Called on product card click. Use for SPA routing. |
| `onClusterClick` | `(cluster: Cluster) => void` | -- | Called on cluster card click. Use for SPA routing. |

### Custom Card Renderers

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `renderProductCard` | `(product: Product) => any` | Built-in `ProductCard` | Custom product card renderer. |
| `renderClusterCard` | `(cluster: Cluster) => any` | Built-in `ClusterCard` | Custom cluster card renderer. |

### Event Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onFiltersChange` | `(filters: AttributeFilter[]) => void` | Emits filterable attributes after each fetch. Use to populate a `GridFilters` sidebar. |
| `onPriceBoundsChange` | `(min: number, max: number) => void` | Emits min/max price of the current result set. Use for a price range slider. |
| `onItemsFoundChange` | `(count: number) => void` | Emits total product count after each fetch. |
| `onPageItemCountChange` | `(count: number) => void` | Emits number of items visible on the current page (after language filtering). |
| `onPageChange` | `(page: number) => void` | Emits the new page number on pagination. |
| `onProductsResponse` | `(products: ProductsResponse) => void` | Emits the full `ProductsResponse` after each fetch. Use to drive a `GridPagination` component. |
| `onCategoryChange` | `(category: Category) => void` | Emits the full `Category` object after each fetch. Use for `GridTitle` or `CategoryDescription`. |
| `onSortChange` | `(sort: any) => void` | Emits sort state changes for syncing a sibling toolbar. |

### Configuration

| Prop | Type | Description |
|------|------|-------------|
| `configuration` | `any` | App config object providing `baseCategoryId`, `imageSearchFiltersGrid`, `imageVariantFiltersMedium`, and `urls.getProductUrl` / `urls.getClusterUrl` for card URL generation. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts



async function fetchProductGrid(
  graphqlClient: GraphQLClient,
  variables: CategoryQueryVariables
): Promise<Category>
```

Returns the `Category` object from `CategoryService.getCategory()`, which contains a `products` field with `items`, `filters`, `minPrice`, `maxPrice`, `itemsFound`, and `pages`.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `categoryId` | `number` | `config.baseCategoryId` | `categoryId` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `taxZone` | `string` | `'NL'` | `taxZone` prop |
| `page` | `number` | `1` | `page` prop |
| `offset` | `number` | `12` | `pageSize` prop |
| `term` | `string` | -- | `term` prop |
| `brand` | `string` | -- | `brand` prop |
| `textFilters` | `ProductTextFilterInput[]` | -- | `textFilters` prop |
| `price.from` | `number` | -- | `priceFilterMin` prop |
| `price.to` | `number` | -- | `priceFilterMax` prop |
| `sortInputs` | `SortInput[]` | -- | `sortField` / `sortOrder` props |
| `statuses` | `string[]` | `['A','P','T','S']` | Always include these statuses |
| `cartId` | `string` | -- | `cartId` prop |

### Cart resolution

The grid passes cart props through to embedded `AddToCart` components. The SDK call sequence:

1. If `cartId` is provided, use it directly for add-to-cart operations via `CartService`.
2. If `createCart` is `true` and no `cartId` exists, `CartService` creates a new cart automatically.
3. After cart creation, the `onCartCreated` callback fires — persist the new cart ID.
4. After each successful add-to-cart, `afterAddToCart` fires with the updated cart.

Refer to the Usage BYO tab examples for implementation details.

### Callbacks table

| Callback | When it fires | What to implement |
|---|---|---|
| `onCartCreated` | After a new cart is created (when `createCart={true}` and no `cartId`) | Persist the new cart to your state/context |
| `afterAddToCart` | After every successful add-to-cart | Update your cart state with the returned cart object |
| `onFiltersChange` | After each product fetch | Update your filter sidebar with the new `AttributeFilter[]` |
| `onPriceBoundsChange` | After each product fetch | Update your price range slider min/max |
| `onItemsFoundChange` | After each product fetch | Update your result count display |
| `onPageItemCountChange` | After each product fetch (post language filtering) | Update your visible item count |
| `onPageChange` | On pagination | Update your page state |
| `onProductsResponse` | After each product fetch | Feed a pagination component with the full response |
| `onCategoryChange` | After each product fetch | Update title/description components |
| `onSortChange` | On sort state changes | Sync a sibling toolbar component |
| `onProductClick` | On product card click | Handle SPA routing |
| `onClusterClick` | On cluster card click | Handle SPA routing |
| `onToggleFavorite` | On favorite toggle | Update favorite state |
| `onProceedToCheckout` | On "Proceed to checkout" click in modal | Navigate to checkout |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `columns` — grid column count
- `className` — extra CSS class on the root element
- `isLoading` — force skeleton loader display
- `showModal` — show modal instead of toast after add-to-cart
- `allowIncrDecr` — show quantity stepper buttons
- `showStock` — show stock widget on cards
- `showAvailability` — show availability indicator
- `stockValidation` — block add-to-cart when exceeding stock
- `portalMode` — control add-to-cart visibility
- `allowAddToCart` — control add-to-cart button visibility
- `enableAddFavorite` — show favorite toggle on cards
- `includeTax` — toggle tax-inclusive price display
- `renderProductCard` — custom product card renderer
- `renderClusterCard` — custom cluster card renderer
- `addToCartLabels` — label overrides for AddToCart
- `stockLabels` — label overrides for ItemStock
- `configuration` — app config object for image filters and URL generation

</TabItem>
</Tabs>

---

## Behavior

### Grid vs List View

The `columns` prop controls the grid layout:
- `1` -- single-column flex layout (list view)
- `2` -- 2-column grid
- `3` (default) -- 2 columns on mobile, 3 on large screens
- `4` -- 2 columns on mobile, 4 on large screens

All multi-column layouts use `auto-rows-fr` for equal row heights.

### Filtering

The grid supports three types of filters, all controlled externally:

- **Text filters** (`textFilters` prop) -- attribute-based filters like color, size, brand. Built from `AttributeFilter` data emitted by `onFiltersChange`.
- **Price range** (`priceFilterMin` / `priceFilterMax` props) -- numeric bounds. Initialize slider limits from `onPriceBoundsChange`.
- **Brand** (`brand` prop) -- manufacturer name filter, switches to catalog-wide search.

When any filter prop changes, the grid automatically re-fetches and the page resets to 1.

### Sorting

Sorting can be controlled externally via `sortField` and `sortOrder` props, or managed internally. Available sort fields include `NAME`, `PRICE`, `RELEVANCE` (auto-selected for search queries), and others from the `ProductSortField` enum. The `onSortChange` callback emits changes for syncing with a toolbar component.

### Pagination

The grid supports both internal and external pagination:

- **Internal** -- the grid tracks `currentPage` and provides `handlePageChange` for built-in Previous/Next controls.
- **External** -- pass a `page` prop to control the current page. Wire `onPageChange` to update your state, and use `onProductsResponse` to feed a `GridPagination` component.

The `pageSize` prop (default 12) sets items per page. Changing it triggers a re-fetch with page reset to 1.

### Cart Integration

The grid passes cart props through to embedded `ProductCard` > `AddToCart` components:

- `cartId` -- ID of an existing cart. When provided, items are added to this cart.
- `createCart` -- when true and no `cartId` is available, AddToCart creates a new cart automatically.
- `onCartCreated` -- callback to persist the newly created cart. Always implement this when using `createCart={true}`.
- `afterAddToCart` -- callback with the updated cart after each add. Use to sync your CartContext.

The add-to-cart button visibility is controlled by `portalMode` and `allowAddToCart`. In `'semi-closed'` portal mode or when `allowAddToCart={false}`, product cards render without add-to-cart controls. Cluster cards always show their navigation button regardless of these settings.

### Language Filtering

After fetching products from the API, the grid filters items client-side to include only those with a `names` entry matching the current `language`. Products without a translation for the active language are excluded from display. The `itemsFound` count is adjusted downward to account for filtered-out untranslated items, ensuring accurate pagination metadata.

When the `language` prop changes, the grid automatically re-fetches all data.

---

## GraphQL Query Examples

### Product listing with filters, sort, and pagination

The grid internally builds a `CategoryQueryVariables` object like this:

```graphql
query Category(
  $categoryId: Int!
  $language: String
  $categoryProductSearchInput: CategoryProductSearchInput
  $priceCalculateProductInput: PriceCalculateProductInput
) {
  category(categoryId: $categoryId) {
    products(
      categoryProductSearchInput: $categoryProductSearchInput
      priceCalculateProductInput: $priceCalculateProductInput
    ) {
      items {
        ... on Product {
          productId
          names { value language }
          descriptions { value language }
          media { images { url } }
          price { net gross }
          sku
          status
          inventory { totalQuantity }
        }
        ... on Cluster {
          clusterId
          names { value language }
          descriptions { value language }
          media { images { url } }
          price { net gross }
        }
      }
      itemsFound
      pages
      filters {
        id
        attributeDescription { name }
        isSearchable
        values { value count }
      }
      minPrice
      maxPrice
    }
  }
}
```

Variables for a category page with text filters and sorting:

```json
{
  "categoryId": 42,
  "language": "NL",
  "categoryProductSearchInput": {
    "language": "NL",
    "page": 1,
    "offset": 12,
    "hidden": false,
    "statuses": ["A", "P", "T", "S"],
    "textFilters": [
      { "searchId": "color", "values": ["red", "blue"] }
    ],
    "sortInputs": [
      { "field": "NAME", "order": "ASC" }
    ]
  },
  "priceCalculateProductInput": {
    "taxZone": "NL"
  }
}
```

Variables for a search query:

```json
{
  "categoryId": 17,
  "language": "NL",
  "categoryProductSearchInput": {
    "language": "NL",
    "page": 1,
    "offset": 12,
    "hidden": false,
    "statuses": ["A", "P", "T", "S"],
    "term": "laptop",
    "searchFields": [
      {
        "fieldNames": ["NAME", "KEYWORDS", "SKU", "CUSTOM_KEYWORDS"],
        "boost": 5
      },
      {
        "fieldNames": ["DESCRIPTION", "MANUFACTURER", "MANUFACTURER_CODE", "EAN_CODE", "BAR_CODE", "CLUSTER_ID", "CUSTOM_KEYWORDS", "PRODUCT_ID", "SHORT_DESCRIPTION", "SUPPLIER", "SUPPLIER_CODE"],
        "boost": 1
      }
    ],
    "sortInputs": [
      { "field": "RELEVANCE", "order": "ASC" }
    ]
  }
}
```

Variables with price range filter:

```json
{
  "categoryId": 42,
  "categoryProductSearchInput": {
    "language": "NL",
    "page": 1,
    "offset": 12,
    "hidden": false,
    "statuses": ["A", "P", "T", "S"],
    "price": {
      "from": 50,
      "to": 200
    }
  }
}
```

---

## SDK Services

ProductGrid uses three SDK services internally:

### CategoryService

The primary service for fetching products. The grid creates a `CategoryService` instance from the provided `graphqlClient` and calls `getCategory()` with a full set of query variables including:

- `categoryId` -- the target category (or `baseCategoryId` for search/brand queries)
- `language` -- locale for product data
- `imageSearchFilters` / `imageVariantFilters` -- from `configuration` for image optimization
- `priceCalculateProductInput` -- includes `taxZone`, `companyId`, `contactId`, or `customerId` depending on user type
- `categoryProductSearchInput` -- the main search input with pagination, sorting, filtering, status filtering, and search term/brand

The response provides `products.items`, `products.filters` (for sidebar), `products.minPrice`/`maxPrice` (for price range), `products.itemsFound`, and `products.pages`.

### ProductService

Not used directly by ProductGrid, but the embedded `ProductCard` components may use it for product-level operations.

### CartService

Used indirectly through the embedded `AddToCart` component inside each `ProductCard`. The grid passes cart-related props (`cartId`, `createCart`, `graphqlClient`, `user`) down to `ProductCard`, which forwards them to `AddToCart`. CartService handles:

- Creating a new cart when `createCart` is true and no `cartId` exists
- Adding products to the cart with the specified quantity
- Returning the updated cart object through `afterAddToCart`

---

## ProductInfo

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-info

# ProductInfo

Displays core product identification -- the product name and SKU. It can either render a pre-fetched `Product` object or fetch one internally via the Propeller SDK when given a `productId` and `graphqlClient`. The `onProductLoaded` callback lets sibling components (gallery, price, descriptions) hydrate from the same product data, making ProductInfo the ideal orchestrator for a product detail page.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Self-contained fetch (recommended for product detail pages)

The component fetches the product internally and notifies siblings via `onProductLoaded`:

```tsx





const [product, setProduct] = useState<Product | null>(null);

<ProductInfo
  user={authState.user}
  productId={42}
  graphqlClient={graphqlClient}
  language="EN"
  imageSearchFilters={imageSearchFilters}
  imageVariantFilters={imageVariantFiltersLarge}
  onProductLoaded={setProduct}
  configuration={config}
/>

{/* Siblings consume the loaded product */}
<ProductPrice price={product?.price} />
<ProductGallery images={product?.media?.images?.items} />
```

### Pre-fetched product (no SDK call)

When you already have the product data, pass it directly. The component renders immediately and still fires `onProductLoaded`:

```tsx
<ProductInfo
  user={authState.user}
  product={existingProduct}
  language="EN"
  onProductLoaded={setProduct}
/>
```

### Title only (hide SKU)

```tsx
<ProductInfo
  user={authState.user}
  product={product}
  showSku={false}
  language="NL"
/>
```

### SKU only (hide title)

```tsx
<ProductInfo
  user={authState.user}
  product={product}
  showTitle={false}
  language="NL"
/>
```

### With attribute-based labels

Display custom product attributes as image badges or text rows:

```tsx
<ProductInfo
  user={authState.user}
  productId={42}
  graphqlClient={graphqlClient}
  configuration={config}
  imageLabels={['new', 'sale']}
  textLabels={['brand', 'color']}
/>
```

### Full product detail page integration

This is the pattern used on the actual product page, where ProductInfo orchestrates data loading for the entire page:

```tsx
const [product, setProduct] = useState<Product | null>(null);

<ProductInfo
  user={state.user}
  productId={productId}
  graphqlClient={graphqlClient}
  language={language}
  imageSearchFilters={imageSearchFilters}
  imageVariantFilters={imageVariantFiltersLarge}
  onProductLoaded={setProduct}
  configuration={config}
/>

<ProductPrice price={product?.price} includeTax={includeTax} />
<ProductBulkPrices bulkPrices={product?.bulkPrices || []} />
<ProductShortDescription product={product} language={language} />
<ItemStock inventory={product?.inventory} />
<AddToCart product={product} />
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom product info component, you need the `Product` type from `propeller-sdk-v2` and a way to resolve localized strings.

### Resolving product name from a pre-fetched product

```ts


function getProductName(product: Product, language = 'NL'): string {
  return product.names?.find(
    (n: LocalizedString) => n.language === language
  )?.value || product.names?.[0]?.value || '';
}

// Access fields:
// - product.sku        -- the SKU string
// - getProductName(product, 'NL') -- the localized product name
```

Render the SKU as a label and the product name as a heading.

### Fetching a product via the SDK

```ts


// pseudo-code: call on initialization and when productId or language changes
async function fetchProduct(
  graphqlClient: GraphQLClient,
  productId: number,
  language = 'NL'
): Promise<Product> {
  const service = new ProductService(graphqlClient);
  return service.getProduct({
    productId,
    language,
    imageSearchFilters: { page: 1, offset: 20 },
    imageVariantFilters: { transformations: [] },
  });
}

// pseudo-code: once the product is loaded, share it with sibling components
// (e.g., price display, image gallery, specifications) to avoid duplicate API calls
```

### Adding attribute labels

```tsx
function getAttributeValue(product: Product, code: string): string | null {
  const attr = product.attributes?.items?.find(
    (a) => a.attributeDescription?.code === code
      || a.attributeDescription?.name === code
  );
  return attr?.textValue || null;
}

// Usage
const brand = getAttributeValue(product, 'brand');
const isNew = getAttributeValue(product, 'new');
```

### Extending with additional product fields

Since `onProductLoaded` passes the full `Product` object, you can build any sibling component without extra API calls:

```ts
// pseudo-code: fetch once, then pass fields to sibling renderers
const product = await fetchProduct(graphqlClient, 42, 'NL');

// Access any field from the full Product object:
// product.price        → pass to price display
// product.media        → pass to image carousel
// product.attributes   → pass to spec table
// product.bulkPrices   → pass to bulk price display
// product.inventory    → pass to stock indicator
// product.categoryPath → pass to breadcrumbs
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data Source

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `user` | `Contact \| Customer \| null` | **(required)** | The authenticated user. Used to build price calculation inputs (companyId, contactId, customerId). |
| `product` | `Product` | `undefined` | Pre-fetched product object. When provided, the component skips internal fetching. |
| `productId` | `number` | `undefined` | Product ID to fetch when no `product` prop is given. Requires `graphqlClient`. |
| `graphqlClient` | `GraphQLClient` | `undefined` | Initialized Propeller SDK GraphQL client. Required when using `productId`. |
| `configuration` | `any` | `undefined` | App config object (from `@/data/config`). Provides fallback `imageSearchFilters`, `imageVariantFiltersLarge`, and `productTrackAttributes`. |

### Image & Price Filters

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `imageSearchFilters` | `any` | Falls back to `configuration.imageSearchFilters` | Controls how many image items are returned. Example: `{ page: 1, offset: 20 }`. |
| `imageVariantFilters` | `any` | Falls back to `configuration.imageVariantFiltersLarge` | Controls image size/format variants. Use `imageVariantFiltersLarge` from `@/data/defaults`. |
| `taxZone` | `string` | `'NL'` | Tax zone for price calculation. |

### Display Toggles

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `showTitle` | `boolean` | `true` | Show the product name as an `<h1>`. |
| `showSku` | `boolean` | `true` | Show the product SKU in a monospace label. |

### Locale & Styling

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `language` | `string` | `'NL'` | Language code used to resolve localized product names from the `names` array. |
| `className` | `string` | `''` | Extra CSS class applied to the root `<div>`. |

### Labels

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `imageLabels` | `string[]` | `undefined` | Attribute codes to display as badge overlays on the product image. Resolved against `product.attributes.items[].attributeDescription.code` (or `.name`). Unmatched codes are silently omitted. |
| `textLabels` | `string[]` | `undefined` | Attribute codes to display as extra text rows below the product name. Resolved the same way as `imageLabels`. |

### Callbacks

| Prop | Type | Description |
|------|------|-------------|
| `onProductLoaded` | `(product: Product) => void` | Fired once product data is available -- immediately when `product` prop is supplied, or after the internal fetch completes. Use this to hydrate sibling components. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchProduct(
  graphqlClient: GraphQLClient,
  productId: number,
  options?: ProductInfoOptions
): Promise<Product>
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `productId` | `number` | **required** | `productId` prop |
| `language` | `string` | `'NL'` | `language` prop |
| `imageSearchFilters` | `any` | `{ page: 1, offset: 20 }` | `imageSearchFilters` prop |
| `imageVariantFilters` | `any` | `configuration.imageVariantFiltersLarge` | `imageVariantFilters` prop |
| `taxZone` | `string` | `'NL'` | `taxZone` prop |
| `user` | `Contact \| Customer \| null` | **required** | `user` prop — used to build `priceCalculateProductInput` and `userBulkPriceProductInput` |

### Callbacks

| Callback | When it fires | What to implement |
|----------|---------------|-------------------|
| `onProductLoaded` | After the product is fetched or when a pre-fetched `product` is provided | Share the loaded `Product` with sibling components to avoid duplicate API calls |

### UI-only props (React component only)

The following props control visual presentation and have no equivalent in a custom implementation:

- `showTitle` — Show/hide the product name heading
- `showSku` — Show/hide the SKU label
- `className` — Extra CSS class on the root element
- `imageLabels` — Attribute codes rendered as badge overlays
- `textLabels` — Attribute codes rendered as text rows

</TabItem>
</Tabs>

---

## Behavior

### Two data modes

1. **Pre-fetched** (`product` prop provided): No SDK call is made. The component renders immediately and fires `onProductLoaded` with the supplied product.
2. **Self-contained** (`productId` + `graphqlClient` provided): The component fetches the product via `ProductService.getProduct()`, shows a skeleton loader during the request, then renders and fires `onProductLoaded`.

### Loading skeleton

While fetching (and no `product` prop is present), the component renders an animated pulse skeleton with two placeholder bars -- a narrow one for the SKU and a wider one for the title.

### Language resolution

The product name is resolved by matching `language` against the `product.names` array (each entry is a `LocalizedString` with `language` and `value`). If no match is found, the first entry in the array is used as a fallback.

### Re-fetch triggers

The internal fetch re-runs when any of these props change:
- `productId`
- `product`
- `language`

### User-aware pricing

The fetch includes `priceCalculateProductInput` and `userBulkPriceProductInput` derived from the `user` prop. For B2B users (Contact), `companyId` and `contactId` are included. For B2C users (Customer), `customerId` is included. This ensures server-side price calculation respects customer-specific pricing tiers.

### Error handling

Fetch errors are caught silently -- the loading state is cleared but no error UI is shown. The component simply remains empty until valid data is available.

---

## SDK Services

ProductInfo uses `ProductService.getProduct()` from `propeller-sdk-v2` when fetching internally.

### Product fields read by the component

| Field | Usage |
|-------|-------|
| `product.names` | Array of `LocalizedString`. The component finds the entry matching `language` and falls back to the first entry. Rendered as the `<h1>` title. |
| `product.sku` | Rendered as the SKU label. |

### Product fields passed through via `onProductLoaded`

The full `Product` object is forwarded to the callback, enabling sibling components to access:

| Field | Consuming component |
|-------|-------------------|
| `product.price` | ProductPrice |
| `product.bulkPrices` | ProductBulkPrices |
| `product.media.images.items` | ProductGallery |
| `product.inventory` | ItemStock |
| `product.categoryPath` | Breadcrumbs |
| `product.slugs` | URL slug resolution |
| `product.attributes` | Label resolution (imageLabels, textLabels) |

### Query variables built internally

When fetching by `productId`, the component constructs the following query variables:

- **`productId`** -- from props
- **`language`** -- from props, defaults to `'NL'`
- **`imageSearchFilters`** -- from props or `configuration.imageSearchFilters`
- **`imageVariantFilters`** -- from props or `configuration.imageVariantFiltersLarge`
- **`priceCalculateProductInput`** -- built from `user` (companyId, contactId, customerId) and `taxZone`
- **`userBulkPriceProductInput`** -- same structure as price input
- **`attributeResultSearchInput`** -- conditionally included when `configuration.productTrackAttributes` is a non-empty array

---

## GraphQL Query Example

The internal fetch calls `ProductService.getProduct()`, which executes a query equivalent to:

```graphql
query GetProduct(
  $productId: Int!
  $language: String
  $imageSearchFilters: ImageSearchInput
  $imageVariantFilters: ImageVariantFilterInput
  $priceCalculateProductInput: PriceCalculateProductInput
  $userBulkPriceProductInput: UserBulkPriceProductInput
  $attributeResultSearchInput: AttributeResultSearchInput
) {
  product(productId: $productId, language: $language) {
    productId
    sku
    names {
      language
      value
    }
    slugs {
      language
      value
    }
    price(input: $priceCalculateProductInput) {
      net
      gross
    }
    bulkPrices(input: $userBulkPriceProductInput) {
      from
      price {
        net
        gross
      }
    }
    media {
      images(input: $imageSearchFilters) {
        items {
          imageVariants(input: $imageVariantFilters) {
            url
          }
        }
      }
    }
    inventory {
      totalQuantity
    }
    categoryPath {
      categoryId
      names {
        language
        value
      }
      slugs {
        language
        value
      }
    }
    attributes(input: $attributeResultSearchInput) {
      items {
        attributeDescription {
          code
          name
        }
        textValue
      }
    }
  }
}
```

Variables for a B2B (Contact) user:

```json
{
  "productId": 42,
  "language": "EN",
  "imageSearchFilters": { "page": 1, "offset": 20 },
  "imageVariantFilters": { "transformations": [] },
  "priceCalculateProductInput": {
    "taxZone": "NL",
    "companyId": 100,
    "contactId": 200
  },
  "userBulkPriceProductInput": {
    "taxZone": "NL",
    "companyId": 100,
    "contactId": 200
  }
}
```

---

## ProductPrice

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-price

# ProductPrice

Displays a product's price with automatic VAT toggle support, secondary price line, cluster option price aggregation, and semi-closed portal mode for catalog-only storefronts.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic — Single Product Price

```tsx


<ProductPriceDisplay
  price={product.price}
  includeTax={true}
/>
```

Renders the incl. VAT price as the leading (large) value and excl. VAT as the secondary (small) line below it.

### With VAT Toggle Integration

```tsx
const [includeTax, setIncludeTax] = useState(true);

useEffect(() => {
  const stored = localStorage.getItem('price_include_tax');
  if (stored !== null) setIncludeTax(stored === 'true');

  const handler = (e: CustomEvent) => setIncludeTax(e.detail);
  window.addEventListener('priceToggleChanged', handler as EventListener);
  return () => window.removeEventListener('priceToggleChanged', handler as EventListener);
}, []);

<ProductPriceDisplay
  price={product.price}
  includeTax={includeTax}
/>
```

When a `PriceToggle` component fires the `priceToggleChanged` event, the leading and secondary prices swap automatically.

### Custom Currency and Size

```tsx
<ProductPriceDisplay
  price={product.price}
  includeTax={true}
  currency="$"
  priceSize="text-xl"
/>
```

### Semi-Closed Portal (Catalog Mode)

```tsx
<ProductPriceDisplay
  price={product.price}
  portalMode="semi-closed"
  user={currentUser}
  labels={{ loginToSeePrices: 'Sign in for pricing' }}
/>
```

When `portalMode` is `"semi-closed"` and no `user` is provided, the price is hidden and replaced with a login prompt.

### Cluster Product with Options

```tsx
<ProductPriceDisplay
  price={cluster.price}
  includeTax={true}
  options={cluster.options}
  selectedOptionProducts={Object.values(selectedOptions)}
/>
```

The component automatically sums the base price with prices from selected option products. For required options where the user has not yet made a selection, the default product's price is included.

### Custom Labels

```tsx
<ProductPriceDisplay
  price={product.price}
  includeTax={true}
  labels={{
    inclTax: 'inc. BTW',
    exclTax: 'ex. BTW',
    loginToSeePrices: 'Inloggen voor prijzen',
  }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

If you need price display logic beyond what this component provides (e.g., original price strikethrough, discount badges, tier pricing), you can build a custom component using the same SDK data:

```tsx


interface CustomPriceProps {
  price: ProductPrice;
  includeTax: boolean;
  currency?: string;
}

function CustomPrice({ price, includeTax, currency = '€' }: CustomPriceProps) {
  const format = (val: number) => `${currency}${val.toFixed(2)}`;

  const currentPrice = includeTax ? price.net : price.gross;
  const originalPrice = includeTax ? price.originalNet : price.originalGross;
  const hasDiscount = originalPrice && originalPrice > (currentPrice || 0);

  return (
    <div className="flex items-baseline gap-2">
      {hasDiscount && (
        <span className="text-sm text-muted-foreground line-through">
          {format(originalPrice)}
        </span>
      )}
      <span className="text-2xl font-bold">
        {currentPrice != null ? format(currentPrice) : ''}
      </span>
      {hasDiscount && price.discount && (
        <span className="text-sm font-semibold text-red-600">
          -{price.discount}%
        </span>
      )}
    </div>
  );
}
```

Key considerations when building your own:

- **Always read `price.net` for incl. VAT and `price.gross` for excl. VAT** -- the SDK naming is inverted from what you might expect.
- **Handle `null`/`undefined`** gracefully. Not all products have both price values populated.
- **Listen to `priceToggleChanged`** if you want to integrate with the app-wide VAT switch.
- **Cluster options** require iterating `ClusterOption[]` and summing selected/default product prices. Refer to the `getOptionsTotal` logic in the component for the complete algorithm.
- **Semi-closed mode** is a simple guard: check for user presence before rendering prices.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `price` | `ProductPrice` | **required** | The price object from `product.price`. Contains `net` (incl. VAT) and `gross` (excl. VAT) values. |
| `includeTax` | `boolean` | `false` | When `true`, the incl. VAT price (`price.net`) is the leading price. When `false`, the excl. VAT price (`price.gross`) leads. |
| `currency` | `string` | `'€'` | Currency symbol prepended to all displayed prices. |

### Cluster Options

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `options` | `ClusterOption[]` | `undefined` | Cluster option groups from `cluster.options`. Used to calculate the total price including option selections. |
| `selectedOptionProducts` | `Product[]` | `undefined` | Currently selected option products. Pass `Object.values(selectedOptionProducts)` from your selection state. The displayed price recalculates whenever this array changes. |

### Portal / Visibility

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `portalMode` | `string` | `'open'` | `'open'` shows prices to everyone. `'semi-closed'` hides prices for anonymous visitors and shows a login prompt instead. |
| `user` | `Contact \| Customer \| null` | `undefined` | The authenticated user. Required for semi-closed mode to determine whether to show or hide prices. |

### Labels and Styling

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `labels` | `Record<string, string>` | `undefined` | Override UI strings. Available keys: `inclTax` (default `'incl. VAT'`), `exclTax` (default `'excl. VAT'`), `loginToSeePrices` (default `'Log in to see prices'`). |
| `priceSize` | `string` | `'text-3xl'` | Tailwind text-size class applied to the leading price. |
| `className` | `string` | `undefined` | Extra CSS class applied to the root `<div>`. |
| `taxZone` | `string` | `'NL'` | Tax zone code (reserved for future use). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderProductPrice(options: {
  price: ProductPrice;
  includeTax?: boolean;
  currency?: string;
  portalMode?: string;
  user?: Contact | Customer | null;
  options?: ClusterOption[];
  selectedOptionProducts?: Product[];
}): void
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `price` | `ProductPrice` | **required** | `price` prop |
| `includeTax` | `boolean` | `false` | `includeTax` prop |
| `currency` | `string` | `'€'` | `currency` prop |
| `portalMode` | `string` | `'open'` | `portalMode` prop |
| `user` | `Contact \| Customer \| null` | `undefined` | `user` prop |
| `options` | `ClusterOption[]` | `undefined` | `options` prop |
| `selectedOptionProducts` | `Product[]` | `undefined` | `selectedOptionProducts` prop |

### UI-only props (React component only)

The following props control visual presentation and have no equivalent in a custom implementation:

- `priceSize` — Tailwind text-size class for the leading price
- `className` — Extra CSS class on the root element
- `taxZone` — Reserved for future use

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|-----|---------|-------------|
| `inclTax` | `'incl. VAT'` | Label shown next to the incl. VAT price |
| `exclTax` | `'excl. VAT'` | Label shown next to the excl. VAT price |
| `loginToSeePrices` | `'Log in to see prices'` | Message shown in semi-closed portal mode when no user is present |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  inclTax: 'incl. VAT',
  exclTax: 'excl. VAT',
  loginToSeePrices: 'Log in to see prices',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Price Toggle (VAT Switch)

The component itself is stateless regarding VAT preference -- it renders based on the `includeTax` prop. The app-wide VAT toggle pattern works as follows:

1. A `PriceToggle` component writes `'true'` or `'false'` to `localStorage` under the key `price_include_tax`.
2. It dispatches a `priceToggleChanged` custom event with the new boolean as `event.detail`.
3. Parent components listen for this event, update their local state, and pass it down as `includeTax`.

This decoupled pattern means ProductPrice works in any context -- with or without the toggle system.

### Leading and Secondary Prices

The component always shows two price lines when both values are available:

- **Leading price**: Large, bold. Controlled by `includeTax`. Shows the primary price with a tax label (e.g., "incl. VAT").
- **Secondary price**: Small, muted. Shows the opposite tax variant below the leading price (e.g., "excl. VAT").

If either `price.net` or `price.gross` is `null` or `undefined`, that line is omitted.

### Cluster Option Price Aggregation

When `options` and `selectedOptionProducts` are provided, the component adds option prices to the base price:

1. Iterates all non-hidden cluster options.
2. For each option, checks if a matching product exists in `selectedOptionProducts`.
3. If found, adds that product's price (net or gross, matching the current `includeTax` setting).
4. If no selection exists but the option is required (`isRequired === 'Y'`), the default product's price is added instead.
5. The total is summed with the base `price.net`/`price.gross` for the final displayed value.

### Semi-Closed Portal Mode

When `portalMode="semi-closed"`:

- **No user provided**: The entire price display is replaced with a login prompt message (customizable via `labels.loginToSeePrices`).
- **User provided**: Prices display normally.

When `portalMode="open"` (the default), prices are always visible regardless of user state.

### Price Formatting

All prices are formatted as `{currency}{value}` with exactly two decimal places. For example, `€99.17`. There are no thousands separators. The currency symbol defaults to `€` but can be overridden via the `currency` prop.

## SDK Services

### Product Price Fields

The `ProductPrice` type from `propeller-sdk-v2` contains two key numeric fields:

| Field | Meaning | Example |
|-------|---------|---------|
| `price.net` | Price **including** VAT | `120.00` |
| `price.gross` | Price **excluding** VAT | `99.17` |

This naming convention is counterintuitive but consistent across the Propeller SDK. The component abstracts this away via the `includeTax` prop:

- `includeTax={true}` shows `price.net` as the leading price and `price.gross` as secondary.
- `includeTax={false}` shows `price.gross` as the leading price and `price.net` as secondary.

Additional price fields that may be available on the `ProductPrice` object:

| Field | Purpose |
|-------|---------|
| `price.originalNet` | Original incl. VAT price before discount |
| `price.originalGross` | Original excl. VAT price before discount |
| `price.discount` | Discount percentage or amount |
| `price.taxCode` | Applied tax rate code |

### GraphQL Query Example

```graphql
query GetProduct($productId: Int!) {
  product(productId: $productId) {
    productId
    name {
      value
    }
    price {
      net
      gross
      originalNet
      originalGross
      discount
      taxCode
    }
  }
}
```

Using the SDK:

```typescript


const productService = new ProductService(graphqlClient);
const product = await productService.getProduct({ productId: 123 });

// product.price.net    → incl. VAT
// product.price.gross  → excl. VAT
```

---

## ProductShortDescription

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-short-description

# ProductShortDescription

Renders a product's short description as HTML content, resolving the correct entry from the product's localized descriptions array.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage with a product

```tsx


<ProductShortDescription product={product} />
```

### With a specific language

```tsx
<ProductShortDescription product={product} language="EN" />
```

### With a cluster

```tsx
<ProductShortDescription product={cluster} language="DE" />
```

### With custom styling

```tsx
<ProductShortDescription
  product={product}
  language="NL"
  className="mt-4 text-sm"
/>
```

### Conditional rendering on a product detail page

```tsx
function ProductDetail({ product }: { product: Product }) {
  return (
    <div>
      <h1>{product.name[0]?.value}</h1>
      <ProductShortDescription product={product} language="EN" />
      {/* Full description, specs, etc. */}
    </div>
  );
}
```

### Inside a product card layout

```tsx
<div className="border rounded-lg p-4">
  <img src={product.media?.[0]?.url} alt={product.name[0]?.value} />
  <h3>{product.name[0]?.value}</h3>
  <ProductShortDescription
    product={product}
    language="NL"
    className="line-clamp-3"
  />
  <AddToCart product={product} />
</div>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom short description display, you need to:

1. **Accept a product or cluster** and a language code as input.
2. **Resolve the localized value** from the `shortDescriptions` array by matching the language.
3. **Render HTML safely** since descriptions may contain markup.

```ts


function getShortDescription(product: Product | Cluster, language: string = 'NL'): string {
  const descriptions = (product as Product).shortDescriptions;
  if (!descriptions?.length) return '';
  const match = descriptions.find((d) => d.language === language);
  return match?.value || descriptions[0]?.value || '';
}

// pseudo-code
const html = getShortDescription(product, 'EN');
// If `html` is empty, hide the element entirely.
// Otherwise, render `html` as raw HTML in your template.
```

Key considerations:

- **Sanitization**: If you do not trust the HTML content source, consider using a library like `dompurify` before rendering.
- **Fallback language**: Always fall back to the first available description when the requested language is not found, so the user sees content rather than nothing.
- **Empty state**: Hide the element entirely when no description exists to avoid rendering empty containers that may affect layout spacing.

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `product` | `Product \| Cluster` | Yes | — | The product or cluster object. The component reads the `shortDescriptions` field. |

### Localization

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `language` | `string` | No | `'NL'` | Language code used to resolve the correct localized short description (e.g., `'EN'`, `'DE'`, `'FR'`). |

### Appearance

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `className` | `string` | No | `''` | Additional CSS class(es) applied to the root `<div>`. Appended after the default Tailwind classes. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function getShortDescription(product: Product | Cluster, language?: string): string
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `product` | `Product \| Cluster` | **required** | `product` prop |
| `language` | `string` | `'NL'` | `language` prop |

### UI-only props (React component only)

The following props control visual presentation and have no equivalent in a custom implementation:

- `className` — Additional CSS class(es) on the root element

</TabItem>
</Tabs>

---

## Behavior

- **Conditional rendering**: The component renders nothing when there is no short description content. No empty wrapper element is added to the DOM.
- **HTML content**: The short description value is rendered as raw HTML using `dangerouslySetInnerHTML`. Content from the Propeller API may include HTML tags such as `<p>`, `<strong>`, `<ul>`, etc.
- **Reactivity**: The component recomputes the displayed description whenever `product` or `language` changes.
- **Default styling**: The root element includes Tailwind prose classes (`prose prose-slate max-w-none text-muted-foreground`) for consistent typography of HTML content. These can be extended or overridden via the `className` prop.
- **Type compatibility**: Accepts both `Product` and `Cluster` objects since both share the `shortDescriptions` field structure.

## SDK Services

This component does not call any SDK services directly. It reads data from a `Product` or `Cluster` object that has already been fetched.

### Required product fields

| Field | Type | Description |
|-------|------|-------------|
| `shortDescriptions` | `LocalizedString[]` | Array of localized short description entries. Each entry has a `language` (string) and `value` (string, may contain HTML). |

The `LocalizedString` type from `propeller-sdk-v2`:

```ts
interface LocalizedString {
  language: string;
  value: string;
}
```

### Language resolution order

1. Find an entry in `shortDescriptions` where `language` matches the `language` prop.
2. If no match is found, fall back to the first entry in the array (`shortDescriptions[0].value`).
3. If `shortDescriptions` is empty or missing, nothing is rendered.

## GraphQL Queries and Mutations

When fetching products, include the `shortDescriptions` field:

```graphql
query GetProduct($productId: Int!, $language: String) {
  product(productId: $productId, language: $language) {
    productId
    name {
      language
      value
    }
    shortDescriptions {
      language
      value
    }
  }
}
```

For clusters:

```graphql
query GetCluster($clusterId: Int!, $language: String) {
  cluster(clusterId: $clusterId, language: $language) {
    clusterId
    name {
      language
      value
    }
    shortDescriptions {
      language
      value
    }
  }
}
```

---

## ProductSlider

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-slider

# ProductSlider

A horizontally scrollable product carousel with built-in data fetching, navigation arrows, and responsive breakpoints. Renders ProductCard and ClusterCard components with full add-to-cart, stock, and favorites support.

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### CMS-driven slider -- fetch products by ID

Content editors define which products appear. The component fetches them internally using `ProductService.getProducts()`.

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  productIds={[123, 456, 789]}
  clusterIds={[101, 202]}
  language="NL"
  taxZone="NL"
  title="Featured Products"
  user={authState.user}
  cartId={cart?.cartId}
  createCart={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  configuration={config}
  onProductClick={(product) => router.push(config.urls.getProductUrl(product))}
  onClusterClick={(cluster) => router.push(config.urls.getClusterUrl(cluster))}
/>
```

### Cross-upsell slider on a product detail page

Fetches accessories and related products for a specific product via `CrossupsellService.getCrossupsells()`. The title auto-generates from the cross-upsell types (e.g., "Accessories & Related products") unless overridden.

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  crossUpsellTypes={['ACCESSORIES', 'RELATED']}
  productId={product.productId}
  language="NL"
  taxZone="NL"
  user={authState.user}
  cartId={cart?.cartId}
  createCart={true}
  onCartCreated={(newCart) => saveCart(newCart)}
  afterAddToCart={(updatedCart) => saveCart(updatedCart)}
  configuration={config}
  onProductClick={(product) => router.push(config.urls.getProductUrl(product))}
  onClusterClick={(cluster) => router.push(config.urls.getClusterUrl(cluster))}
/>
```

### Cross-upsell slider for a cluster

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  crossUpsellTypes={['ALTERNATIVES']}
  clusterId={cluster.clusterId}
  language="NL"
  taxZone="NL"
  configuration={config}
  onProductClick={(product) => router.push(config.urls.getProductUrl(product))}
/>
```

### Pre-loaded items (skip fetching)

Pass an array of already-fetched Product or Cluster objects. No API call is made.

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  products={preLoadedProducts}
  language="NL"
  taxZone="NL"
  title="Hand-picked Products"
  configuration={config}
  onProductClick={(product) => router.push(config.urls.getProductUrl(product))}
/>
```

### Catalog-only mode (no add-to-cart)

Set `portalMode="semi-closed"` to hide the add-to-cart button on each card.

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  productIds={[10, 20, 30]}
  language="NL"
  taxZone="NL"
  portalMode="semi-closed"
  configuration={config}
  onProductClick={(product) => router.push(config.urls.getProductUrl(product))}
/>
```

### Custom responsive layout

```tsx
<ProductSlider
  graphqlClient={graphqlClient}
  productIds={[10, 20, 30, 40, 50, 60]}
  language="NL"
  taxZone="NL"
  itemsPerView={{ mobile: 2, tablet: 3, desktop: 5 }}
  configuration={config}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom slider or replace the built-in fetching logic:

1. **Fetch data externally** using `ProductService` or `CrossupsellService` as shown above.
2. **Pass results via the `products` prop** to skip internal fetching entirely.
3. **Wire up cart integration** by passing `cartId`, `createCart`, `onCartCreated`, and `afterAddToCart` to keep the app's CartContext in sync.
4. **Handle routing** with `onProductClick` and `onClusterClick` callbacks rather than relying on anchor tags, so the slider works with any router.

Example -- fetch externally with custom filtering, then pass results via the `products` prop:

```ts


// pseudo-code: call this on initialization or when productIds change
const productService = new ProductService(graphqlClient);
const res = await productService.getProducts({
  input: {
    productIds: cmsBlock.productIds,
    language: 'NL',
    page: 1,
    offset: 20,
    statuses: [Enums.ProductStatus.A],
  },
  imageSearchFilters: config.imageSearchFiltersGrid,
  imageVariantFilters: config.imageVariantFiltersMedium,
  filterAvailableAttributeInput: { isSearchable: true },
});

// Custom filter: only items with images
const items = (res.items || []).filter(
  (item: Product | Cluster) => item.media?.images?.length > 0
);

// pseudo-code: pass `items` to the ProductSlider's `products` prop to skip internal fetching
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data Source

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | Yes | -- | Propeller SDK client for API calls. |
| `products` | `(Product \| Cluster)[]` | No | `[]` | Pre-loaded items. Skips all internal fetching when provided. |
| `productIds` | `number[]` | No | -- | Product IDs to fetch (CMS mode). |
| `clusterIds` | `number[]` | No | -- | Cluster IDs to fetch (CMS mode). |
| `crossUpsellTypes` | `string[]` | No | -- | Enables cross-upsell mode. Values: `'ACCESSORIES'`, `'ALTERNATIVES'`, `'RELATED'`, `'OPTIONS'`, `'PARTS'`. |
| `productId` | `number` | No | -- | Source product for cross-upsell lookup. Required when `crossUpsellTypes` is set. |
| `clusterId` | `number` | No | -- | Source cluster for cross-upsell lookup. Required when `crossUpsellTypes` is set. |

### Locale and Pricing

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `language` | `string` | Yes | -- | Language code for API requests and localized content. |
| `taxZone` | `string` | Yes | -- | Tax zone for price calculations. |
| `includeTax` | `boolean` | No | -- | Override the VAT toggle. When omitted, follows the `price_include_tax` localStorage value and `priceToggleChanged` event. |

### Layout

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `title` | `string` | No | -- | Heading displayed above the slider. In cross-upsell mode, auto-generates from the type names if omitted. |
| `itemsPerView` | `{ mobile?: number; tablet?: number; desktop?: number }` | No | `{ mobile: 1, tablet: 2, desktop: 4 }` | Number of visible cards at each breakpoint. |
| `containerClassName` | `string` | No | `'mb-12'` | CSS class for the outermost wrapper. |

### Portal and Visibility

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `portalMode` | `'open' \| 'semi-closed'` | No | `'open'` | `'open'` shows add-to-cart on product cards. `'semi-closed'` hides it for a catalog-only view. |
| `user` | `Contact \| Customer \| null` | No | `null` | Authenticated user, forwarded to cards for cart and pricing operations. |

### Cart Integration

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `cartId` | `string` | No | -- | Existing cart ID to add items to. |
| `createCart` | `boolean` | No | `false` | Auto-create a cart when none exists. Pair with `onCartCreated`. |
| `onCartCreated` | `(cart: Cart) => void` | No | -- | Called after a new cart is created internally. |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | No | -- | Called after every successful add-to-cart with the updated cart. |
| `stockValidation` | `boolean` | No | `false` | Validate stock before adding to cart. |
| `showIncrDecr` | `boolean` | No | `true` | Show +/- stepper buttons on add-to-cart. |
| `showModal` | `boolean` | No | `false` | Show a success modal instead of a toast after adding to cart. |
| `onProceedToCheckout` | `() => void` | No | -- | Called when "Proceed to checkout" is clicked in the add-to-cart modal. |

### Stock Display

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `showStock` | `boolean` | No | `false` | Show the stock/availability widget on each card. |
| `showAvailability` | `boolean` | No | `true` | Show only the availability indicator (Available / Not available). |
| `stockLabels` | `Record<string, string>` | No | -- | Label overrides for ItemStock. Keys: `inStock`, `outOfStock`, `lowStock`, `available`, `notAvailable`, `pieces`. |

### Favorites

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `enableAddFavorite` | `boolean` | No | `false` | Show a heart-icon toggle on each card. |
| `onToggleFavorite` | `(item: Product \| Cluster, isFavorite: boolean) => void` | No | -- | Called when a favorite is toggled. |

### Navigation Callbacks

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `onProductClick` | `(product: Product) => void` | No | -- | Called when a product card is clicked. Use for SPA-style routing. |
| `onClusterClick` | `(cluster: Cluster) => void` | No | -- | Called when a cluster card is clicked. |

### Labels and Configuration

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `configuration` | `any` | No | -- | App config object providing `imageSearchFiltersGrid`, `imageVariantFiltersMedium`, and `urls` for URL generation. |
| `labels` | `Record<string, string>` | No | -- | UI string overrides (see Labels section). |
| `addToCartLabels` | `Record<string, string>` | No | -- | Label overrides forwarded to the AddToCart component inside each card. Keys: `add`, `adding`, `addedToCart`, `outOfStock`, `noCartId`, `errorAdding`, `modalTitle`, `quantity`, `continueShopping`, `proceedToCheckout`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
async function fetchSliderProducts(options: {
  graphqlClient: GraphQLClient;
  productIds?: number[];
  clusterIds?: number[];
  crossUpsellTypes?: string[];
  productId?: number;
  clusterId?: number;
  language: string;
  taxZone: string;
  configuration?: any;
  user?: Contact | Customer | null;
}): Promise<(Product | Cluster)[]>
```

### Options

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `graphqlClient` | `GraphQLClient` | **required** | `graphqlClient` prop |
| `productIds` | `number[]` | `undefined` | `productIds` prop |
| `clusterIds` | `number[]` | `undefined` | `clusterIds` prop |
| `crossUpsellTypes` | `string[]` | `undefined` | `crossUpsellTypes` prop |
| `productId` | `number` | `undefined` | `productId` prop |
| `clusterId` | `number` | `undefined` | `clusterId` prop |
| `language` | `string` | **required** | `language` prop |
| `taxZone` | `string` | **required** | `taxZone` prop |
| `configuration` | `any` | `undefined` | `configuration` prop |
| `user` | `Contact \| Customer \| null` | `null` | `user` prop |

### Cart resolution

When adding items to cart from within the slider, the component resolves the cart as follows:

1. If `cartId` is provided, use the existing cart.
2. If `createCart` is `true` and no `cartId` exists, auto-create a new cart and fire `onCartCreated`.
3. After every successful add-to-cart, fire `afterAddToCart` with the updated cart.

### Callbacks

| Callback | Signature | Purpose |
|----------|-----------|---------|
| `onCartCreated` | `(cart: Cart) => void` | Persist newly created cart to app state |
| `afterAddToCart` | `(cart: Cart, item?: CartMainItem) => void` | Sync updated cart to app state |
| `onProductClick` | `(product: Product) => void` | Handle product card navigation |
| `onClusterClick` | `(cluster: Cluster) => void` | Handle cluster card navigation |
| `onToggleFavorite` | `(item: Product \| Cluster, isFavorite: boolean) => void` | Handle favorite toggle |
| `onProceedToCheckout` | `() => void` | Handle checkout navigation from add-to-cart modal |

### UI-only props (React component only)

The following props control visual presentation and have no equivalent in a custom implementation:

- `title` — Heading above the slider
- `itemsPerView` — Responsive card counts
- `containerClassName` — CSS class for the outermost wrapper
- `showIncrDecr` — Show +/- stepper buttons
- `showModal` — Show modal vs toast after add-to-cart
- `stockLabels` — Label overrides for stock widget
- `addToCartLabels` — Label overrides for AddToCart component

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `scrollLeft` | `'Scroll left'` | Left arrow aria-label. |
| `scrollRight` | `'Scroll right'` | Right arrow aria-label. |
| `noProducts` | `'No products found'` | Empty state message (CMS mode only). |
| `ACCESSORIES` | `'Accessories'` | Cross-upsell type display name. |
| `ALTERNATIVES` | `'Alternatives'` | Cross-upsell type display name. |
| `RELATED` | `'Related products'` | Cross-upsell type display name. |
| `OPTIONS` | `'Options'` | Cross-upsell type display name. |
| `PARTS` | `'Parts'` | Cross-upsell type display name. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const defaultLabels = {
  scrollLeft: 'Scroll left',
  scrollRight: 'Scroll right',
  noProducts: 'No products found',
  ACCESSORIES: 'Accessories',
  ALTERNATIVES: 'Alternatives',
  RELATED: 'Related products',
  OPTIONS: 'Options',
  PARTS: 'Parts',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Responsive Card Widths

Card widths are calculated with CSS `calc()` to fill the container minus gaps:

- **Mobile** (default): `calc((100% - 1.5rem) / 1.5)` -- shows ~1.5 cards, hinting that more content is scrollable.
- **Tablet** (`md`): `calc((100% - 3rem) / 2.5)` -- shows ~2.5 cards.
- **Desktop** (`lg`): `calc((100% - 4.5rem) / 4)` -- shows 4 full cards.

The partial-card pattern is intentional: it signals to the user that the row is scrollable.

### Scroll Navigation

- Left/right arrow buttons appear when the number of items exceeds the desktop count.
- Each click scrolls the track by 80% of its visible width using `scrollBy({ behavior: 'smooth' })`.
- Arrows disable automatically at scroll boundaries (left arrow at the start, right arrow at the end).
- Scroll position is tracked via the native `onScroll` event.

### Loading and Empty States

- **Loading**: Displays four animated skeleton cards (gray pulsing rectangles) while fetching.
- **Empty (CMS mode)**: Shows the `noProducts` label ("No products found" by default).
- **Empty (cross-upsell mode)**: The entire component hides itself. This is intentional -- a product may have no cross-upsells, and showing an empty section would be confusing.

### Re-fetching

The component re-fetches automatically when any of these props change:
- `productIds` or `clusterIds` (compared by value via `JSON.stringify`, not by reference — prevents stale-reference refetches when arrays are re-created with the same contents)
- `crossUpsellTypes` (compared by value via `JSON.stringify`)
- `productId` or `clusterId` (cross-upsell source)
- `language`

### Scroll initialization

The slider generates a unique `sliderId` on mount (via `Math.random()`) and uses a `data-slider-id` DOM attribute to query scroll dimensions. Scroll dimensions are initialized with a 50ms `setTimeout` after the slider ID is set, to ensure the DOM has fully rendered.

### CMS-Driven Content (Strapi)

Add a `shared.product-slider` component in Strapi with fields for `title`, `productIds` (comma-separated text), and `clusterIds` (comma-separated text). A CMS block wrapper (`ProductSliderBlock`) parses these fields into number arrays and handles auth, cart, and configuration wiring automatically, so editors only need to enter IDs.

### Mixed Content

A single slider can contain both Product and Cluster items. The component detects the item type by checking for `clusterId` vs `productId` and renders the appropriate card (ClusterCard or ProductCard).

### VAT Toggle

Each card respects the global VAT toggle. The `includeTax` prop overrides the toggle when set explicitly. When omitted, cards read from `localStorage` (`price_include_tax`) and listen for the `priceToggleChanged` custom event.

## SDK Services

### ProductService -- CMS mode

When `productIds` or `clusterIds` are provided (and `products` is not), the component calls `ProductService.getProducts()` internally:

```ts
const productService = new ProductService(graphqlClient);
const response = await productService.getProducts({
  input: {
    productIds: [123, 456],
    clusterIds: [101],
    language: 'NL',
    page: 1,
    offset: 50,
    statuses: [
      Enums.ProductStatus.A,  // Active
      Enums.ProductStatus.P,  // Published
      Enums.ProductStatus.T,  // Temporary
      Enums.ProductStatus.S,  // Stock
    ],
  },
  imageSearchFilters: configuration?.imageSearchFiltersGrid || { page: 1, offset: 1 },
  imageVariantFilters: configuration?.imageVariantFiltersMedium || {
    transformations: [{
      name: 'grid',
      transformation: {
        format: Enums.Format.WEBP,
        height: 300,
        width: 300,
        fit: Enums.Fit.BOUNDS,
      },
    }],
  },
  filterAvailableAttributeInput: { isSearchable: true },
});
```

The response shape is `{ items: (Product | Cluster)[] }`. Both products and clusters can appear in a single response.

### CrossupsellService -- cross-upsell mode

When `crossUpsellTypes` is set along with `productId` or `clusterId`, the component calls `CrossupsellService.getCrossupsells()`:

```ts
const crossupsellService = new CrossupsellService(graphqlClient);
const result = await crossupsellService.getCrossupsells({
  input: {
    types: ['ACCESSORIES', 'RELATED'],
    page: 1,
    offset: 50,
    productIdsFrom: [product.productId],
    // or: clusterIdsFrom: [cluster.clusterId],
  },
  language: 'NL',
  imageSearchFilters: configuration?.imageSearchFiltersGrid,
  imageVariantFilters: configuration?.imageVariantFiltersMedium,
  priceCalculateProductInput: {
    taxZone: 'NL',
    companyId: user?.company?.companyId,   // B2B Contact
    contactId: user?.contactId,            // B2B Contact
    customerId: user?.customerId,          // B2C Customer
  },
});
```

The response contains `{ items: Crossupsell[] }`. Each `Crossupsell` has either a `productTo` or `clusterTo` field referencing the related item.

**Known limitation**: `CrossupsellService.getCrossupsells()` has a known SDK bug where undeclared fragment variables cause an HTTP 400. Cross-upsell results may not display until the SDK is fixed. The error is caught silently.

## GraphQL Queries and Mutations

### Fetch products by ID (what ProductService.getProducts sends)

```graphql
query products(
  $input: ProductSearchInput!
  $imageSearchFilters: ProductImageSearchInput
  $imageVariantFilters: ProductImageVariantSearchInput
) {
  products(input: $input) {
    items {
      productId
      sku
      name { value language }
      slug { value language }
      price { net gross }
      media(input: $imageSearchFilters) {
        images {
          url
          variants(input: $imageVariantFilters) { url }
        }
      }
    }
    itemsFound
  }
}
```

Variables:

```json
{
  "input": {
    "productIds": [123, 456],
    "language": "NL",
    "page": 1,
    "offset": 50,
    "statuses": ["A", "P", "T", "S"]
  },
  "imageSearchFilters": { "page": 1, "offset": 1 },
  "imageVariantFilters": {
    "transformations": [{
      "name": "grid",
      "transformation": { "format": "WEBP", "height": 300, "width": 300, "fit": "BOUNDS" }
    }]
  }
}
```

### Fetch cross-upsells for a product

```graphql
query crossupsells(
  $input: CrossupsellSearchInput!
  $language: String
  $imageSearchFilters: ProductImageSearchInput
  $imageVariantFilters: ProductImageVariantSearchInput
) {
  crossupsells(input: $input) {
    items {
      type
      productTo {
        productId
        name(language: $language) { value }
        slug(language: $language) { value }
        price { net gross }
      }
      clusterTo {
        clusterId
        name(language: $language) { value }
        slug(language: $language) { value }
      }
    }
  }
}
```

Variables:

```json
{
  "input": {
    "types": ["ACCESSORIES", "RELATED"],
    "productIdsFrom": [123],
    "page": 1,
    "offset": 50
  },
  "language": "NL"
}
```

---

## ProductSpecifications

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-specifications

# ProductSpecifications

Renders product attributes/specifications as a table or stacked list, with optional grouping by attribute group. The component can fetch attributes autonomously via the SDK or accept pre-fetched data.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Self-contained: fetch by product ID

```tsx



<ProductSpecifications
  graphqlClient={graphqlClient}
  productId={12345}
  language="EN"
/>
```

### Pre-fetched attributes (no SDK client needed)

```tsx


// attributes already available from a parent query
<ProductSpecifications
  attributes={product.attributeResults}
  language="EN"
/>
```

### List layout

```tsx
<ProductSpecifications
  graphqlClient={graphqlClient}
  productId={12345}
  layout="list"
/>
```

### Grouped by attribute group

```tsx
<ProductSpecifications
  graphqlClient={graphqlClient}
  productId={12345}
  grouping={true}
/>
```

### Grouped list layout with custom class

```tsx
<ProductSpecifications
  graphqlClient={graphqlClient}
  productId={12345}
  layout="list"
  grouping={true}
  className="mt-8"
/>
```

### Static attributes without grouping (e.g., quick-view modal)

```tsx
<ProductSpecifications
  attributes={selectedProduct.attributeResults}
  language="NL"
  layout="list"
  className="text-sm"
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom specifications component, you need:

1. **Fetch attributes** using `ProductService.getAttributeResultByProductId(productId, filter)` or include `attributeResults` in your product query.

2. **Filter to public attributes** by checking `attributeDescription.isPublic === true`.

3. **Resolve labels** by matching `attributeDescription.descriptions` against your target language, falling back to `attributeDescription.name`.

4. **Extract values by type** using `value.type` to determine which field holds the actual data:
   - `TEXT` -- find the matching language in `textValues`, join the `values` array
   - `ENUM` -- join `enumValues` array
   - `INT` -- read `intValue`
   - `DECIMAL` -- read `decimalValue`
   - `DATETIME` -- read `dateTimeValue`
   - `COLOR` -- read `colorValue`
   - Fallback -- read `value.value`, convert booleans to readable strings

5. **Group attributes** (optional) by reading `attributeDescription.group`. Collect unique groups in encounter order and partition attributes accordingly.

### Fetch attributes via the SDK

```ts


// pseudo-code: call on initialization and when productId changes
async function fetchSpecs(graphqlClient: GraphQLClient, productId: number): Promise<AttributeResult[]> {
  const service = new ProductService(graphqlClient);
  const res = await service.getAttributeResultByProductId(productId, {
    attributeDescription: { isPublic: true },
    page: 1,
    offset: 500,
  });
  return res?.items || [];
}
```

### Map attributes to display data

```ts
function mapAttribute(attr: AttributeResult, language: string): { label: string; value: string } | null {
  // Resolve label
  const label = attr.attributeDescription?.descriptions?.find(
    (d) => d.language === language
  )?.value || attr.attributeDescription?.name || '';

  // Extract value by type
  let value: string;
  switch (attr.value?.type) {
    case 'TEXT':
      value = attr.value.textValues?.find((t) => t.language === language)?.values?.join(', ') || '';
      break;
    case 'ENUM':
      value = attr.value.enumValues?.join(', ') || '';
      break;
    case 'INT':
      value = String(attr.value.intValue ?? '');
      break;
    case 'DECIMAL':
      value = String(attr.value.decimalValue ?? '');
      break;
    case 'DATETIME':
      value = attr.value.dateTimeValue || '';
      break;
    case 'COLOR':
      value = attr.value.colorValue || '';
      break;
    default:
      value = typeof attr.value?.value === 'boolean'
        ? (attr.value.value ? 'Yes' : 'No')
        : String(attr.value?.value ?? '');
  }

  if (!value || value === '0') return null;
  return { label, value };
}
```

From there, render the mapped attributes however you like -- table rows, cards, accordion panels, definition lists, comparison tables, etc. For grouped display, partition attributes by `attributeDescription.group` in encounter order.

### Pre-fetched attributes

```ts
// When attributes are already available from a parent query,
// skip the fetch and pass them directly to your rendering logic:
const specs = product.attributeResults
  .filter((attr) => attr.attributeDescription?.isPublic)
  .map((attr) => mapAttribute(attr, 'EN'))
  .filter(Boolean);
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Data

| Prop | Type | Default | Description |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | `undefined` | Initialized Propeller SDK client. Required when `productId` is set. |
| `productId` | `number` | `undefined` | Product ID to fetch attributes for. When set, the component fetches its own data and ignores `attributes`. |
| `attributes` | `AttributeResult[]` | `undefined` | Pre-fetched attribute results. Used as fallback when `productId` is not provided. |

### Display

| Prop | Type | Default | Description |
|---|---|---|---|
| `layout` | `'table' \| 'list'` | `'table'` | `'table'` renders a two-column table (name / value). `'list'` renders vertically stacked label + value rows. |
| `grouping` | `boolean` | `false` | When `true`, groups attributes by their `attributeDescription.group` field and renders a heading per section. |

### Localization

| Prop | Type | Default | Description |
|---|---|---|---|
| `language` | `string` | `'NL'` | Language code used to resolve localized attribute labels and text-type values. |

### Styling

| Prop | Type | Default | Description |
|---|---|---|---|
| `className` | `string` | `undefined` | Extra CSS class applied to the root wrapper element. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts


async function fetchSpecs(
  graphqlClient: GraphQLClient,
  productId: number
): Promise<AttributeResult[]>
```

Returns an array of `AttributeResult` objects from `ProductService.getAttributeResultByProductId()`.

### Options table

| Field | Type | Default | Maps to |
|---|---|---|---|
| `graphqlClient` | `GraphQLClient` | *(required for fetch mode)* | `graphqlClient` prop |
| `productId` | `number` | -- | `productId` prop |
| `attributes` | `AttributeResult[]` | -- | `attributes` prop (pre-fetched fallback) |
| `language` | `string` | `'NL'` | `language` prop |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `layout` — table or list display mode
- `grouping` — whether to group attributes by `attributeDescription.group`
- `className` — extra CSS class on the root element

</TabItem>
</Tabs>

---

## Behavior

- **Auto-hide when empty**: The component renders nothing when there are no public attributes or while loading. There is no empty-state message.
- **Filtering**: Only attributes where `attributeDescription.isPublic === true` are shown. Attributes with empty, null, or `'0'` values are excluded.
- **Data priority**: When `productId` is provided, the component fetches its own data and ignores the `attributes` prop entirely. When `productId` is absent, it falls back to `attributes`.
- **Re-fetch on product change**: Changing the `productId` prop triggers a new fetch automatically.
- **Localization resolution**: For labels, the component searches `attributeDescription.descriptions` for a matching `language` entry. If none is found, it falls back to `attributeDescription.name`. For `TEXT`-type values, it filters `textValues` by language.
- **Attribute type handling**: Each attribute type (`TEXT`, `ENUM`, `INT`, `DECIMAL`, `DATETIME`, `COLOR`) has dedicated extraction logic. Unknown types fall back to `value.value`, with booleans rendered as "Yes"/"No".
- **Group ordering**: Groups appear in the order they are first encountered in the attribute list (insertion order, not alphabetical).
- **Group headings**: In grouped mode, a heading is rendered for each group that has a non-empty group name. Attributes with no group are rendered without a heading.
- **Loading state**: A loading flag is set during fetch but no spinner is shown; the component simply renders nothing until data arrives.
- **Error handling**: Fetch errors are caught silently. The component remains hidden if no data is available.

---

## GraphQL Query

If you need to fetch product specifications/attributes outside the component (e.g., in a server component or parent query), use the following query structure:

```graphql
query ProductAttributes($productId: Int!) {
  product(id: $productId) {
    attributeResults(
      filter: { attributeDescription: { isPublic: true } }
      page: 1
      offset: 100
    ) {
      items {
        attributeDescription {
          name
          isPublic
          group
          descriptions {
            language
            value
          }
        }
        value {
          type
          ... on AttributeTextValue {
            textValues {
              language
              values
            }
          }
          ... on AttributeEnumValue {
            enumValues
          }
          ... on AttributeIntValue {
            intValue
          }
          ... on AttributeDecimalValue {
            decimalValue
          }
          ... on AttributeDateTimeValue {
            dateTimeValue
          }
          ... on AttributeColorValue {
            colorValue
          }
        }
      }
    }
  }
}
```

Pass the returned `items` array to the `attributes` prop:

```tsx
<ProductSpecifications attributes={data.product.attributeResults.items} />
```

---

## SDK Services

The component uses `ProductService.getAttributeResultByProductId()` to fetch attributes when `productId` is provided.

### Product fields read

The component works with the `AttributeResult` type from the SDK. Each attribute result contains:

| Field path | Usage |
|---|---|
| `attributeDescription.isPublic` | Filters to only public attributes |
| `attributeDescription.name` | Fallback label when no localized description matches |
| `attributeDescription.descriptions[]` | Array of `LocalizedString` objects; matched by `language` to resolve the display label |
| `attributeDescription.group` | Used to section attributes when `grouping={true}` |
| `value.type` | Determines how to extract the display value (`TEXT`, `ENUM`, `INT`, `DECIMAL`, `DATETIME`, `COLOR`) |
| `value.textValues[]` | For `TEXT` type: array with `language` and `values` fields |
| `value.enumValues[]` | For `ENUM` type: string array |
| `value.intValue` | For `INT` type: numeric value |
| `value.decimalValue` | For `DECIMAL` type: numeric value |
| `value.dateTimeValue` | For `DATETIME` type: string value |
| `value.colorValue` | For `COLOR` type: string value |
| `value.value` | Generic fallback; booleans render as "Yes"/"No" |

### Fetch parameters

When fetching autonomously, the component calls:

```ts
service.getAttributeResultByProductId(productId, {
  attributeDescription: { isPublic: true },
  page: 1,
  offset: 2000,
});
```

This requests up to 2000 public attributes in a single call.

---

## ProductTabs

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-tabs

# ProductTabs

A tabbed content organizer for product detail pages. Combines four sub-components — Description, Specifications, Downloads, and Videos — into a unified interface with horizontal tabs on desktop and an accordion on mobile.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage with all tabs

```tsx
<ProductTabs
  product={product}
  graphqlClient={graphqlClient}
  productId={product.productId}
/>
```

### Only description and specifications

```tsx
<ProductTabs
  product={product}
  graphqlClient={graphqlClient}
  productId={product.productId}
  showDownloads={false}
  showVideos={false}
/>
```

### Collapsed description with custom labels

```tsx
<ProductTabs
  product={product}
  graphqlClient={graphqlClient}
  productId={product.productId}
  descriptionCollapsed={true}
  descriptionMaxLength={300}
  labels={{
    description: 'Overview',
    specifications: 'Tech Specs',
    downloads: 'Documents',
    videos: 'Media',
  }}
/>
```

### Grouped specifications in list layout

```tsx
<ProductTabs
  product={product}
  graphqlClient={graphqlClient}
  productId={product.productId}
  specificationsLayout="list"
  specificationsGrouping={true}
  language="EN"
/>
```

### Custom labels for sub-components

```tsx
<ProductTabs
  product={product}
  graphqlClient={graphqlClient}
  productId={product.productId}
  downloadsLabels={{ title: 'Product Documents', download: 'Get file' }}
  videosLabels={{ title: 'Product Videos' }}
/>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To create a custom tabbed product detail layout:

1. **Fetch the product** with `descriptions`, `attributes`, and `media` fields populated in your GraphQL query.

2. **Initialize the GraphQL client** for the Specifications tab to fetch attributes independently:
   ```tsx
   import { GraphQLClient } from 'propeller-sdk-v2';
   const graphqlClient = new GraphQLClient({ endpoint, apiKey, authToken });
   ```

3. **Use individual sub-components** if you need full control over layout instead of the tab wrapper:
   - `ProductDescription` — renders HTML description with optional collapse/expand
   - `ProductSpecifications` — renders attributes as a table or list, optionally grouped
   - `ProductDownloads` — renders downloadable document links
   - `ProductVideos` — renders embedded video players

4. **Implement responsive behavior** yourself. The built-in component uses `hidden md:block` / `md:hidden` Tailwind classes to switch between tabs and accordion. You can replace this with your own breakpoint logic or always use one layout.

5. **Style with Tailwind** using semantic color tokens (`border-border`, `text-foreground`, `text-muted-foreground`) for theme compatibility. The active tab uses a bottom border (`border-b-2 border-foreground`) and the accordion chevron rotates 180 degrees when expanded.

### Fetching attributes independently

When `product.attributes` is not populated in the initial product query, you can fetch attributes via the SDK:

```ts


const graphqlClient = new GraphQLClient({ endpoint, apiKey, authToken });
const productService = new ProductService(graphqlClient);

// Fetch public attributes for the specifications tab
const attributes = await productService.getAttributeResultByProductId({
  attributeDescription: { isPublic: true },
  page: 1,
  offset: 2000,
});
```

### Basic tab layout skeleton

```ts


// Assume `product` is already fetched with descriptions, attributes, media fields

// Resolve description by language
const language = 'NL';
const description = product.descriptions?.find(d => d.language === language)
  || product.descriptions?.[0];

// Fetch attributes if not already populated
const graphqlClient = new GraphQLClient({ endpoint, apiKey, authToken });
const productService = new ProductService(graphqlClient);
const attributes = await productService.getAttributeResultByProductId({
  attributeDescription: { isPublic: true },
  page: 1,
  offset: 2000,
});

// Access documents and videos
const documents = product.media?.documents;
const videos = product.media?.videos;

// Render your own tabbed UI with the data above
// Not documented in source — implement based on your setup
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Core

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `product` | `Product` | *required* | The product object containing descriptions, attributes, media documents, and media videos. |
| `language` | `string` | `'NL'` | Language code passed to all sub-components for localized content resolution. |
| `labels` | `Record<string, string>` | `{}` | Override the tab button labels. Keys: `description`, `specifications`, `downloads`, `videos`. |
| `className` | `string` | `''` | Extra CSS class applied to the root element. |

### Tab Visibility

All default to `true`. Set to `false` to hide a tab entirely.

| Prop | Type | Description |
|------|------|-------------|
| `showDescription` | `boolean` | Show or hide the Description tab. Automatically hidden if the product has no description for the active language. |
| `showSpecifications` | `boolean` | Show or hide the Specifications tab. |
| `showDownloads` | `boolean` | Show or hide the Downloads tab. |
| `showVideos` | `boolean` | Show or hide the Videos tab. |

### Description Options

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `descriptionCollapsed` | `boolean` | `false` | When `true`, truncates the description to `descriptionMaxLength` characters with a "Read more" / "Read less" toggle. |
| `descriptionMaxLength` | `number` | `0` | Maximum characters shown when collapsed. `0` means no truncation. |

### Specifications Options

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `graphqlClient` | `GraphQLClient` | `undefined` | Initialized Propeller SDK GraphQL client, passed to ProductSpecifications for attribute fetching. |
| `productId` | `number` | `undefined` | Product ID for fetching attributes via the SDK. |
| `specificationsLayout` | `string` | `'table'` | Display layout: `'table'` (two-column name/value) or `'list'` (vertical stacked rows). |
| `specificationsGrouping` | `boolean` | `false` | When `true`, groups specifications by their group field with a heading per section. |

### Downloads & Videos Labels

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `downloadsLabels` | `Record<string, string>` | `{}` | Override UI strings for the Downloads section. Keys: `title`, `download`. |
| `videosLabels` | `Record<string, string>` | `{}` | Override UI strings for the Videos section. Key: `title`. |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function createProductTabs(options: {
  product: Product;
  graphqlClient?: GraphQLClient;
  productId?: number;
  language?: string;
}): void
```

Types from `propeller-sdk-v2`: `Product`, `GraphQLClient`.

### Options table

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `product` | `Product` | *required* | `product` prop — the product object with descriptions, attributes, media |
| `graphqlClient` | `GraphQLClient` | `undefined` | `graphqlClient` prop — SDK client for fetching attributes independently |
| `productId` | `number` | `undefined` | `productId` prop — product ID for attribute fetch via `ProductService.getAttributeResultByProductId()` |
| `language` | `string` | `'NL'` | `language` prop — language code for localized content resolution |
| `specificationsLayout` | `string` | `'table'` | `specificationsLayout` prop — `'table'` or `'list'` display format |
| `specificationsGrouping` | `boolean` | `false` | `specificationsGrouping` prop — whether to group attributes by group field |
| `descriptionCollapsed` | `boolean` | `false` | `descriptionCollapsed` prop — truncate description with expand toggle |
| `descriptionMaxLength` | `number` | `0` | `descriptionMaxLength` prop — max characters when collapsed |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `className` — extra CSS class on the root element
- `labels` — tab button label overrides (`description`, `specifications`, `downloads`, `videos`)
- `showDescription`, `showSpecifications`, `showDownloads`, `showVideos` — tab visibility toggles
- `downloadsLabels` — UI string overrides for the Downloads section
- `videosLabels` — UI string overrides for the Videos section

</TabItem>
</Tabs>

---

## Behavior

### Tab Switching

- **Desktop** (md and above): Horizontal tab bar with an underline indicator on the active tab. Clicking a tab replaces the visible content panel below.
- **Mobile** (below md): Accordion layout with chevron icons. Tapping a section header toggles it open or closed. Only one section is open at a time — opening a new section closes the previous one. Tapping the currently open section closes it (all collapsed state).

### Initial Tab Selection

On mount, the component selects the first visible tab in this priority order:

1. Description (if enabled and the product has description content)
2. Specifications
3. Downloads
4. Videos

If the product or language changes after mount, the component re-evaluates and resets to the Description tab when applicable.

### Lazy Loading of Specifications

The Specifications sub-component is not rendered until the user visits the Specifications tab at least once. On desktop, after the first visit it stays mounted (hidden via CSS `hidden` class) to preserve fetched data. On mobile (accordion), the specs section is only rendered when both visited AND currently active — it unmounts when collapsed. The attribute fetch via `ProductService.getAttributeResultByProductId()` fires when the tab is first visited and `graphqlClient` + `productId` are provided.

### Description Auto-Hide

The Description tab is automatically excluded from the tab bar when the product has no description content for the current language (and no fallback description exists). The next available tab becomes the default.

---

## SDK Services & Product Fields

ProductTabs reads the following fields from the `Product` object (from `propeller-sdk-v2`):

| Field | Used By | Purpose |
|-------|---------|---------|
| `product.descriptions` | Description tab | Array of `{ language, value }` objects. The component matches by `language` prop (default `'NL'`), falling back to the first entry. If no description exists, the Description tab is automatically hidden. |
| `product.attributes.items` | Specifications tab | Array of `AttributeResult` objects passed directly to ProductSpecifications. |
| `product.media.documents` | Downloads tab | `PaginatedMediaDocumentResponse` containing downloadable files associated with the product. |
| `product.media.videos` | Videos tab | `PaginatedMediaVideoResponse` containing video entries associated with the product. |

The Specifications tab can also fetch attributes independently via `graphqlClient` and `productId`, which is useful when `product.attributes` is not populated in the initial product query. When fetching independently, the component calls `ProductService.getAttributeResultByProductId()` with `{ attributeDescription: { isPublic: true }, page: 1, offset: 2000 }`. This fetch is triggered only when the Specifications tab is first visited (lazy-loaded).

---

## ProductVideos

URL: https://docs.propeller-commerce.com/reference/storefront-sdk/product-display/product-videos

# ProductVideos

Renders product videos as embedded players (YouTube, Vimeo) or native HTML5 `<video>` elements. Automatically detects the video platform from the URI and converts it to an embeddable format. Resolves localized video URIs and titles based on the provided language code.

---

## Usage

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Basic usage on a product detail page

```tsx


<ProductVideos
  videos={product.media.videos}
  language="EN"
/>
```

### With custom labels

```tsx
<ProductVideos
  videos={product.media.videos}
  language="NL"
  labels={{
    title: 'Productvideo\'s',
    empty: 'Geen video\'s beschikbaar',
  }}
/>
```

### With custom styling

```tsx
<ProductVideos
  videos={product.media.videos}
  language="EN"
  className="mt-6 max-w-2xl"
/>
```

### Conditionally rendering only when videos exist

```tsx
{product.media?.videos?.items?.length > 0 && (
  <ProductVideos
    videos={product.media.videos}
    language="EN"
    labels={{ title: 'Watch' }}
  />
)}
```

### Inside a tabbed product detail layout

```tsx
<Tabs>
  <Tab label="Description">
    <ProductDescription ... />
  </Tab>
  <Tab label="Videos">
    <ProductVideos
      videos={product.media.videos}
      language={currentLanguage}
    />
  </Tab>
</Tabs>
```

</TabItem>
<TabItem value="byo" label="Build Your Own">

To build a custom video component, keep these points in mind:

1. **Accept `PaginatedMediaVideoResponse`** as your data shape. This is the standard format returned by the Propeller API for product media videos.

2. **Resolve localized fields manually.** Both `MediaVideo.videos` (URIs) and `MediaVideo.alt` (titles) are arrays of localized entries. Filter by language code and provide a fallback.

3. **Convert watch URLs to embed URLs.** YouTube and Vimeo watch/share URLs do not work inside iframes. Extract the video ID and construct the embed URL:
   - YouTube: `https://www.youtube.com/embed/{videoId}`
   - Vimeo: `https://player.vimeo.com/video/{videoId}`

4. **Use a 16:9 aspect ratio container for iframes.** Iframes do not auto-size to their content. The `padding-bottom: 56.25%` technique with `position: absolute` on the iframe ensures responsive sizing.

5. **Fall back to native `<video>` for non-embeddable URIs.** Self-hosted or CDN video files can be played directly with the HTML5 video element. Use `preload="metadata"` to keep initial page load light.

6. **Handle the empty state.** Always check `items.length` before rendering the list, and show a meaningful fallback message.

### Example skeleton

```tsx
function CustomProductVideos({ videos, language }: {
  videos: PaginatedMediaVideoResponse;
  language: string;
}) {
  const items = videos?.items || [];

  const resolveUri = (video: MediaVideo) => {
    const match = video.videos?.find(v => v.language === language);
    return match?.uri || video.videos?.[0]?.uri || '';
  };

  if (items.length === 0) {
    return <p>No videos available</p>;
  }

  return (
    <div>
      {items.map((video, i) => {
        const uri = resolveUri(video);
        const embedUrl = toEmbedUrl(uri); // your conversion logic
        return embedUrl !== uri
          ? <iframe key={i} src={embedUrl} ... />
          : <video key={i} controls src={uri} />;
      })}
    </div>
  );
}
```

</TabItem>
</Tabs>

## Configuration

<Tabs groupId="implementation">
<TabItem value="react" label="React">

### Required

| Prop | Type | Description |
|---|---|---|
| `videos` | `PaginatedMediaVideoResponse` | The video media object from the product. Pass `product.media.videos` directly. |
| `language` | `string` | Two-letter language code (e.g. `"EN"`, `"NL"`) used to resolve the correct localized video URI and title. Falls back to `"NL"` when empty. |

### Optional — Appearance

| Prop | Type | Default | Description |
|---|---|---|---|
| `className` | `string` | `undefined` | Additional CSS class applied to the root `<div>`. |

### Optional — Labels

| Prop | Type | Default | Description |
|---|---|---|---|
| `labels` | `Record<string, string>` | `undefined` | Override UI strings. Supported keys: `title` (heading above the video list, default `"Videos"`), `empty` (message when no videos exist, default `"No videos"`). |

</TabItem>
<TabItem value="byo" label="Build Your Own">

### Function signature

```ts
function renderProductVideos(options: {
  videos: PaginatedMediaVideoResponse;
  language: string;
}): void
```

Types from `propeller-sdk-v2`: `PaginatedMediaVideoResponse`, `MediaVideo`.

### Options table

| Field | Type | Default | Maps to |
|-------|------|---------|---------|
| `videos` | `PaginatedMediaVideoResponse` | *required* | `videos` prop — the video media object from `product.media.videos` |
| `language` | `string` | `'NL'` | `language` prop — language code for resolving localized video URIs and titles |

### UI-only props

The following props are purely presentational and are not part of the SDK layer. They are the developer's responsibility to implement:

- `className` — additional CSS class on the root element
- `labels` — UI string overrides (`title`, `empty`)

</TabItem>
</Tabs>

## Labels

<Tabs groupId="implementation">
<TabItem value="react" label="React">

| Key | Default | Description |
|---|---|---|
| `title` | `"Videos"` | Heading above the video list |
| `empty` | `"No videos"` | Message when no videos exist |

</TabItem>
<TabItem value="byo" label="Build Your Own">

```ts
const labels = {
  title: 'Videos',
  empty: 'No videos',
};
```

These are suggested defaults. Override per-key to support localization.

</TabItem>
</Tabs>

---

## Behavior

### Platform detection and embedding

The component inspects each video URI to determine how to render it:

| Platform | URL patterns detected | Rendered as |
|---|---|---|
| YouTube | `youtube.com/watch?v=...`, `youtu.be/...` | `<iframe>` pointing to `youtube.com/embed/{id}` |
| Vimeo | `vimeo.com/{id}` | `<iframe>` pointing to `player.vimeo.com/video/{id}` |
| Other (self-hosted, CDN) | Any URI not matching above | Native `<video>` element with controls |

Embedded iframes use a 16:9 aspect ratio (`padding-bottom: 56.25%`) and load lazily. They allow accelerometer, autoplay, clipboard-write, encrypted-media, gyroscope, and picture-in-picture permissions.

Native video players use `preload="metadata"` to avoid downloading full video files until the user hits play.

### Empty state

When `videos.items` is empty or not provided, the component renders a muted text message (default: "No videos"). The heading is hidden in this case.

### Rendering order

Videos are rendered in the same order they appear in the `items` array. Each video is wrapped in a rounded, bordered container with a black background.

---

## GraphQL Query Example

When fetching a product, include the `media.videos` field to supply data to this component:

```graphql
query GetProduct($productId: Int!, $language: String) {
  product(id: $productId, language: $language) {
    productId
    name {
      language
      value
    }
    media {
      videos {
        items {
          videos {
            language
            uri
          }
          alt {
            language
            value
          }
        }
      }
    }
  }
}
```

---

## SDK Services

This component does **not** call any SDK service directly. It is a presentational component that receives data through its `videos` prop.

### Product fields consumed

The `videos` prop expects the `PaginatedMediaVideoResponse` type, which is found at `product.media.videos`. The component reads the following nested fields:

| Field path | Type | Purpose |
|---|---|---|
| `videos.items` | `MediaVideo[]` | The list of video entries to render. |
| `videos.items[].videos` | `LocalizedVideo[]` | Localized video URIs. Each entry has `language` (string) and `uri` (string). |
| `videos.items[].alt` | `LocalizedString[]` | Localized alt text / titles. Each entry has `language` (string) and `value` (string). |

### Language resolution

For both URIs and titles, the component:

1. Searches the localized array for an entry matching the `language` prop.
2. Falls back to the first entry in the array if no match is found.
3. Falls back to an empty string (URI) or `"Video"` (title) if the array is empty.

---